osconfig

package
v0.213.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2024 License: BSD-3-Clause Imports: 18 Imported by: 1

Documentation

Overview

Package osconfig provides access to the OS Config API.

For product documentation, see: https://cloud.google.com/compute/docs/osconfig/rest

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/osconfig/v1"
...
ctx := context.Background()
osconfigService, err := osconfig.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

osconfigService, err := osconfig.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
osconfigService, err := osconfig.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AptSettings

type AptSettings struct {
	// Excludes: List of packages to exclude from update. These packages will be
	// excluded
	Excludes []string `json:"excludes,omitempty"`
	// ExclusivePackages: An exclusive list of packages to be updated. These are
	// the only packages that will be updated. If these packages are not installed,
	// they will be ignored. This field cannot be specified with any other patch
	// configuration fields.
	ExclusivePackages []string `json:"exclusivePackages,omitempty"`
	// Type: By changing the type to DIST, the patching is performed using `apt-get
	// dist-upgrade` instead.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - By default, upgrade will be performed.
	//   "DIST" - Runs `apt-get dist-upgrade`.
	//   "UPGRADE" - Runs `apt-get upgrade`.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Excludes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Excludes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AptSettings: Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed.

func (AptSettings) MarshalJSON

func (s AptSettings) MarshalJSON() ([]byte, error)

type CVSSv3 added in v0.53.0

type CVSSv3 struct {
	// AttackComplexity: This metric describes the conditions beyond the attacker's
	// control that must exist in order to exploit the vulnerability.
	//
	// Possible values:
	//   "ATTACK_COMPLEXITY_UNSPECIFIED" - Invalid value.
	//   "ATTACK_COMPLEXITY_LOW" - Specialized access conditions or extenuating
	// circumstances do not exist. An attacker can expect repeatable success when
	// attacking the vulnerable component.
	//   "ATTACK_COMPLEXITY_HIGH" - A successful attack depends on conditions
	// beyond the attacker's control. That is, a successful attack cannot be
	// accomplished at will, but requires the attacker to invest in some measurable
	// amount of effort in preparation or execution against the vulnerable
	// component before a successful attack can be expected.
	AttackComplexity string `json:"attackComplexity,omitempty"`
	// AttackVector: This metric reflects the context by which vulnerability
	// exploitation is possible.
	//
	// Possible values:
	//   "ATTACK_VECTOR_UNSPECIFIED" - Invalid value.
	//   "ATTACK_VECTOR_NETWORK" - The vulnerable component is bound to the network
	// stack and the set of possible attackers extends beyond the other options
	// listed below, up to and including the entire Internet.
	//   "ATTACK_VECTOR_ADJACENT" - The vulnerable component is bound to the
	// network stack, but the attack is limited at the protocol level to a
	// logically adjacent topology.
	//   "ATTACK_VECTOR_LOCAL" - The vulnerable component is not bound to the
	// network stack and the attacker's path is via read/write/execute
	// capabilities.
	//   "ATTACK_VECTOR_PHYSICAL" - The attack requires the attacker to physically
	// touch or manipulate the vulnerable component.
	AttackVector string `json:"attackVector,omitempty"`
	// AvailabilityImpact: This metric measures the impact to the availability of
	// the impacted component resulting from a successfully exploited
	// vulnerability.
	//
	// Possible values:
	//   "IMPACT_UNSPECIFIED" - Invalid value.
	//   "IMPACT_HIGH" - High impact.
	//   "IMPACT_LOW" - Low impact.
	//   "IMPACT_NONE" - No impact.
	AvailabilityImpact string `json:"availabilityImpact,omitempty"`
	// BaseScore: The base score is a function of the base metric scores.
	// https://www.first.org/cvss/specification-document#Base-Metrics
	BaseScore float64 `json:"baseScore,omitempty"`
	// ConfidentialityImpact: This metric measures the impact to the
	// confidentiality of the information resources managed by a software component
	// due to a successfully exploited vulnerability.
	//
	// Possible values:
	//   "IMPACT_UNSPECIFIED" - Invalid value.
	//   "IMPACT_HIGH" - High impact.
	//   "IMPACT_LOW" - Low impact.
	//   "IMPACT_NONE" - No impact.
	ConfidentialityImpact string `json:"confidentialityImpact,omitempty"`
	// ExploitabilityScore: The Exploitability sub-score equation is derived from
	// the Base Exploitability metrics.
	// https://www.first.org/cvss/specification-document#2-1-Exploitability-Metrics
	ExploitabilityScore float64 `json:"exploitabilityScore,omitempty"`
	// ImpactScore: The Impact sub-score equation is derived from the Base Impact
	// metrics.
	ImpactScore float64 `json:"impactScore,omitempty"`
	// IntegrityImpact: This metric measures the impact to integrity of a
	// successfully exploited vulnerability.
	//
	// Possible values:
	//   "IMPACT_UNSPECIFIED" - Invalid value.
	//   "IMPACT_HIGH" - High impact.
	//   "IMPACT_LOW" - Low impact.
	//   "IMPACT_NONE" - No impact.
	IntegrityImpact string `json:"integrityImpact,omitempty"`
	// PrivilegesRequired: This metric describes the level of privileges an
	// attacker must possess before successfully exploiting the vulnerability.
	//
	// Possible values:
	//   "PRIVILEGES_REQUIRED_UNSPECIFIED" - Invalid value.
	//   "PRIVILEGES_REQUIRED_NONE" - The attacker is unauthorized prior to attack,
	// and therefore does not require any access to settings or files of the
	// vulnerable system to carry out an attack.
	//   "PRIVILEGES_REQUIRED_LOW" - The attacker requires privileges that provide
	// basic user capabilities that could normally affect only settings and files
	// owned by a user. Alternatively, an attacker with Low privileges has the
	// ability to access only non-sensitive resources.
	//   "PRIVILEGES_REQUIRED_HIGH" - The attacker requires privileges that provide
	// significant (e.g., administrative) control over the vulnerable component
	// allowing access to component-wide settings and files.
	PrivilegesRequired string `json:"privilegesRequired,omitempty"`
	// Scope: The Scope metric captures whether a vulnerability in one vulnerable
	// component impacts resources in components beyond its security scope.
	//
	// Possible values:
	//   "SCOPE_UNSPECIFIED" - Invalid value.
	//   "SCOPE_UNCHANGED" - An exploited vulnerability can only affect resources
	// managed by the same security authority.
	//   "SCOPE_CHANGED" - An exploited vulnerability can affect resources beyond
	// the security scope managed by the security authority of the vulnerable
	// component.
	Scope string `json:"scope,omitempty"`
	// UserInteraction: This metric captures the requirement for a human user,
	// other than the attacker, to participate in the successful compromise of the
	// vulnerable component.
	//
	// Possible values:
	//   "USER_INTERACTION_UNSPECIFIED" - Invalid value.
	//   "USER_INTERACTION_NONE" - The vulnerable system can be exploited without
	// interaction from any user.
	//   "USER_INTERACTION_REQUIRED" - Successful exploitation of this
	// vulnerability requires a user to take some action before the vulnerability
	// can be exploited.
	UserInteraction string `json:"userInteraction,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttackComplexity") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttackComplexity") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CVSSv3: Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document

func (CVSSv3) MarshalJSON added in v0.53.0

func (s CVSSv3) MarshalJSON() ([]byte, error)

func (*CVSSv3) UnmarshalJSON added in v0.53.0

func (s *CVSSv3) UnmarshalJSON(data []byte) error

type CancelOperationRequest added in v0.59.0

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type CancelPatchJobRequest

type CancelPatchJobRequest struct {
}

CancelPatchJobRequest: Message for canceling a patch job.

type Date added in v0.58.0

type Date struct {
	// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,
	// or 0 to specify a year by itself or a year and month where the day isn't
	// significant.
	Day int64 `json:"day,omitempty"`
	// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without
	// a month and day.
	Month int64 `json:"month,omitempty"`
	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
	// without a year.
	Year int64 `json:"year,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Day") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Day") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

func (Date) MarshalJSON added in v0.58.0

func (s Date) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type ExecStep

type ExecStep struct {
	// LinuxExecStepConfig: The ExecStepConfig for all Linux VMs targeted by the
	// PatchJob.
	LinuxExecStepConfig *ExecStepConfig `json:"linuxExecStepConfig,omitempty"`
	// WindowsExecStepConfig: The ExecStepConfig for all Windows VMs targeted by
	// the PatchJob.
	WindowsExecStepConfig *ExecStepConfig `json:"windowsExecStepConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LinuxExecStepConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LinuxExecStepConfig") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExecStep: A step that runs an executable for a PatchJob.

func (ExecStep) MarshalJSON

func (s ExecStep) MarshalJSON() ([]byte, error)

type ExecStepConfig

type ExecStepConfig struct {
	// AllowedSuccessCodes: Defaults to [0]. A list of possible return values that
	// the execution can return to indicate a success.
	AllowedSuccessCodes []int64 `json:"allowedSuccessCodes,omitempty"`
	// GcsObject: A Cloud Storage object containing the executable.
	GcsObject *GcsObject `json:"gcsObject,omitempty"`
	// Interpreter: The script interpreter to use to run the script. If no
	// interpreter is specified the script will be executed directly, which will
	// likely only succeed for scripts with [shebang lines]
	// (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
	//
	// Possible values:
	//   "INTERPRETER_UNSPECIFIED" - If the interpreter is not specified, the value
	// defaults to `NONE`.
	//   "NONE" - Indicates that the file is run as follows on each operating
	// system: + For Linux VMs, the file is ran as an executable and the
	// interpreter might be parsed from the [shebang
	// line](https://wikipedia.org/wiki/Shebang_(Unix)) of the file. + For Windows
	// VM, this value is not supported.
	//   "SHELL" - Indicates that the file is run with `/bin/sh` on Linux and `cmd`
	// on Windows.
	//   "POWERSHELL" - Indicates that the file is run with PowerShell.
	Interpreter string `json:"interpreter,omitempty"`
	// LocalPath: An absolute path to the executable on the VM.
	LocalPath string `json:"localPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedSuccessCodes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedSuccessCodes") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExecStepConfig: Common configurations for an ExecStep.

func (ExecStepConfig) MarshalJSON

func (s ExecStepConfig) MarshalJSON() ([]byte, error)

type ExecutePatchJobRequest

type ExecutePatchJobRequest struct {
	// Description: Description of the patch job. Length of the description is
	// limited to 1024 characters.
	Description string `json:"description,omitempty"`
	// DisplayName: Display name for this patch job. This does not have to be
	// unique.
	DisplayName string `json:"displayName,omitempty"`
	// DryRun: If this patch is a dry-run only, instances are contacted but will do
	// nothing.
	DryRun bool `json:"dryRun,omitempty"`
	// Duration: Duration of the patch job. After the duration ends, the patch job
	// times out.
	Duration string `json:"duration,omitempty"`
	// InstanceFilter: Required. Instances to patch, either explicitly or filtered
	// by some criteria such as zone or labels.
	InstanceFilter *PatchInstanceFilter `json:"instanceFilter,omitempty"`
	// PatchConfig: Patch configuration being applied. If omitted, instances are
	// patched using the default configurations.
	PatchConfig *PatchConfig `json:"patchConfig,omitempty"`
	// Rollout: Rollout strategy of the patch job.
	Rollout *PatchRollout `json:"rollout,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExecutePatchJobRequest: A request message to initiate patching across Compute Engine instances.

func (ExecutePatchJobRequest) MarshalJSON

func (s ExecutePatchJobRequest) MarshalJSON() ([]byte, error)

type FixedOrPercent added in v0.30.0

type FixedOrPercent struct {
	// Fixed: Specifies a fixed value.
	Fixed int64 `json:"fixed,omitempty"`
	// Percent: Specifies the relative value defined as a percentage, which will be
	// multiplied by a reference value.
	Percent int64 `json:"percent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Fixed") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Fixed") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FixedOrPercent: Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.

func (FixedOrPercent) MarshalJSON added in v0.30.0

func (s FixedOrPercent) MarshalJSON() ([]byte, error)

type GcsObject

type GcsObject struct {
	// Bucket: Required. Bucket of the Cloud Storage object.
	Bucket string `json:"bucket,omitempty"`
	// GenerationNumber: Required. Generation number of the Cloud Storage object.
	// This is used to ensure that the ExecStep specified by this PatchJob does not
	// change.
	GenerationNumber int64 `json:"generationNumber,omitempty,string"`
	// Object: Required. Name of the Cloud Storage object.
	Object string `json:"object,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Bucket") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Bucket") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GcsObject: Cloud Storage object representation.

func (GcsObject) MarshalJSON

func (s GcsObject) MarshalJSON() ([]byte, error)

type GooSettings

type GooSettings struct {
}

GooSettings: Googet patching is performed by running `googet update`.

type GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata added in v0.61.0

type GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata struct {
	// ApiMethod: The OS policy assignment API method.
	//
	// Possible values:
	//   "API_METHOD_UNSPECIFIED" - Invalid value
	//   "CREATE" - Create OS policy assignment API method
	//   "UPDATE" - Update OS policy assignment API method
	//   "DELETE" - Delete OS policy assignment API method
	ApiMethod string `json:"apiMethod,omitempty"`
	// OsPolicyAssignment: Reference to the `OSPolicyAssignment` API resource.
	// Format:
	// `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_polic
	// y_assignment_id@revision_id}`
	OsPolicyAssignment string `json:"osPolicyAssignment,omitempty"`
	// RolloutStartTime: Rollout start time
	RolloutStartTime string `json:"rolloutStartTime,omitempty"`
	// RolloutState: State of the rollout
	//
	// Possible values:
	//   "ROLLOUT_STATE_UNSPECIFIED" - Invalid value
	//   "IN_PROGRESS" - The rollout is in progress.
	//   "CANCELLING" - The rollout is being cancelled.
	//   "CANCELLED" - The rollout is cancelled.
	//   "SUCCEEDED" - The rollout has completed successfully.
	RolloutState string `json:"rolloutState,omitempty"`
	// RolloutUpdateTime: Rollout update time
	RolloutUpdateTime string `json:"rolloutUpdateTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiMethod") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiMethod") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata: OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.

func (GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata) MarshalJSON added in v0.61.0

type GoogleCloudOsconfigV2beta__OperationMetadata added in v0.202.0

type GoogleCloudOsconfigV2beta__OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have been cancelled
	// successfully have Operation.error value with a google.rpc.Status.code of 1,
	// corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudOsconfigV2beta__OperationMetadata: Represents the metadata of the long-running operation.

func (GoogleCloudOsconfigV2beta__OperationMetadata) MarshalJSON added in v0.202.0

type Inventory added in v0.36.0

type Inventory struct {
	// Items: Inventory items related to the VM keyed by an opaque unique
	// identifier for each inventory item. The identifier is unique to each
	// distinct and addressable inventory item and will change, when there is a new
	// package version.
	Items map[string]InventoryItem `json:"items,omitempty"`
	// Name: Output only. The `Inventory` API resource name. Format:
	// `projects/{project_number}/locations/{location}/instances/{instance_id}/inven
	// tory`
	Name string `json:"name,omitempty"`
	// OsInfo: Base level operating system information for the VM.
	OsInfo *InventoryOsInfo `json:"osInfo,omitempty"`
	// UpdateTime: Output only. Timestamp of the last reported inventory for the
	// VM.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Inventory: This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see Information provided by OS inventory management (https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).

func (Inventory) MarshalJSON added in v0.36.0

func (s Inventory) MarshalJSON() ([]byte, error)

type InventoryItem added in v0.36.0

type InventoryItem struct {
	// AvailablePackage: Software package available to be installed on the VM
	// instance.
	AvailablePackage *InventorySoftwarePackage `json:"availablePackage,omitempty"`
	// CreateTime: When this inventory item was first detected.
	CreateTime string `json:"createTime,omitempty"`
	// Id: Identifier for this item, unique across items for this VM.
	Id string `json:"id,omitempty"`
	// InstalledPackage: Software package present on the VM instance.
	InstalledPackage *InventorySoftwarePackage `json:"installedPackage,omitempty"`
	// OriginType: The origin of this inventory item.
	//
	// Possible values:
	//   "ORIGIN_TYPE_UNSPECIFIED" - Invalid. An origin type must be specified.
	//   "INVENTORY_REPORT" - This inventory item was discovered as the result of
	// the agent reporting inventory via the reporting API.
	OriginType string `json:"originType,omitempty"`
	// Type: The specific type of inventory, correlating to its specific details.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Invalid. A type must be specified.
	//   "INSTALLED_PACKAGE" - This represents a package that is installed on the
	// VM.
	//   "AVAILABLE_PACKAGE" - This represents an update that is available for a
	// package.
	Type string `json:"type,omitempty"`
	// UpdateTime: When this inventory item was last modified.
	UpdateTime string `json:"updateTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AvailablePackage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AvailablePackage") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryItem: A single piece of inventory on a VM.

func (InventoryItem) MarshalJSON added in v0.36.0

func (s InventoryItem) MarshalJSON() ([]byte, error)

type InventoryOsInfo added in v0.36.0

type InventoryOsInfo struct {
	// Architecture: The system architecture of the operating system.
	Architecture string `json:"architecture,omitempty"`
	// Hostname: The VM hostname.
	Hostname string `json:"hostname,omitempty"`
	// KernelRelease: The kernel release of the operating system.
	KernelRelease string `json:"kernelRelease,omitempty"`
	// KernelVersion: The kernel version of the operating system.
	KernelVersion string `json:"kernelVersion,omitempty"`
	// LongName: The operating system long name. For example 'Debian GNU/Linux 9'
	// or 'Microsoft Window Server 2019 Datacenter'.
	LongName string `json:"longName,omitempty"`
	// OsconfigAgentVersion: The current version of the OS Config agent running on
	// the VM.
	OsconfigAgentVersion string `json:"osconfigAgentVersion,omitempty"`
	// ShortName: The operating system short name. For example, 'windows' or
	// 'debian'.
	ShortName string `json:"shortName,omitempty"`
	// Version: The version of the operating system.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Architecture") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Architecture") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryOsInfo: Operating system information for the VM.

func (InventoryOsInfo) MarshalJSON added in v0.36.0

func (s InventoryOsInfo) MarshalJSON() ([]byte, error)

type InventorySoftwarePackage added in v0.36.0

type InventorySoftwarePackage struct {
	// AptPackage: Details of an APT package. For details about the apt package
	// manager, see https://wiki.debian.org/Apt.
	AptPackage *InventoryVersionedPackage `json:"aptPackage,omitempty"`
	// CosPackage: Details of a COS package.
	CosPackage *InventoryVersionedPackage `json:"cosPackage,omitempty"`
	// GoogetPackage: Details of a Googet package. For details about the googet
	// package manager, see https://github.com/google/googet.
	GoogetPackage *InventoryVersionedPackage `json:"googetPackage,omitempty"`
	// QfePackage: Details of a Windows Quick Fix engineering package. See
	// https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering
	// for info in Windows Quick Fix Engineering.
	QfePackage *InventoryWindowsQuickFixEngineeringPackage `json:"qfePackage,omitempty"`
	// WindowsApplication: Details of Windows Application.
	WindowsApplication *InventoryWindowsApplication `json:"windowsApplication,omitempty"`
	// WuaPackage: Details of a Windows Update package. See
	// https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information
	// about Windows Update.
	WuaPackage *InventoryWindowsUpdatePackage `json:"wuaPackage,omitempty"`
	// YumPackage: Yum package info. For details about the yum package manager, see
	// https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum.
	YumPackage *InventoryVersionedPackage `json:"yumPackage,omitempty"`
	// ZypperPackage: Details of a Zypper package. For details about the Zypper
	// package manager, see https://en.opensuse.org/SDB:Zypper_manual.
	ZypperPackage *InventoryVersionedPackage `json:"zypperPackage,omitempty"`
	// ZypperPatch: Details of a Zypper patch. For details about the Zypper package
	// manager, see https://en.opensuse.org/SDB:Zypper_manual.
	ZypperPatch *InventoryZypperPatch `json:"zypperPatch,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AptPackage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AptPackage") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventorySoftwarePackage: Software package information of the operating system.

func (InventorySoftwarePackage) MarshalJSON added in v0.36.0

func (s InventorySoftwarePackage) MarshalJSON() ([]byte, error)

type InventoryVersionedPackage added in v0.36.0

type InventoryVersionedPackage struct {
	// Architecture: The system architecture this package is intended for.
	Architecture string `json:"architecture,omitempty"`
	// PackageName: The name of the package.
	PackageName string `json:"packageName,omitempty"`
	// Version: The version of the package.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Architecture") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Architecture") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryVersionedPackage: Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.

func (InventoryVersionedPackage) MarshalJSON added in v0.36.0

func (s InventoryVersionedPackage) MarshalJSON() ([]byte, error)

type InventoryWindowsApplication added in v0.58.0

type InventoryWindowsApplication struct {
	// DisplayName: The name of the application or product.
	DisplayName string `json:"displayName,omitempty"`
	// DisplayVersion: The version of the product or application in string format.
	DisplayVersion string `json:"displayVersion,omitempty"`
	// HelpLink: The internet address for technical support.
	HelpLink string `json:"helpLink,omitempty"`
	// InstallDate: The last time this product received service. The value of this
	// property is replaced each time a patch is applied or removed from the
	// product or the command-line option is used to repair the product.
	InstallDate *Date `json:"installDate,omitempty"`
	// Publisher: The name of the manufacturer for the product or application.
	Publisher string `json:"publisher,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryWindowsApplication: Contains information about a Windows application that is retrieved from the Windows Registry. For more information about these fields, see: https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key

func (InventoryWindowsApplication) MarshalJSON added in v0.58.0

func (s InventoryWindowsApplication) MarshalJSON() ([]byte, error)

type InventoryWindowsQuickFixEngineeringPackage added in v0.36.0

type InventoryWindowsQuickFixEngineeringPackage struct {
	// Caption: A short textual description of the QFE update.
	Caption string `json:"caption,omitempty"`
	// Description: A textual description of the QFE update.
	Description string `json:"description,omitempty"`
	// HotFixId: Unique identifier associated with a particular QFE update.
	HotFixId string `json:"hotFixId,omitempty"`
	// InstallTime: Date that the QFE update was installed. Mapped from
	// installed_on field.
	InstallTime string `json:"installTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Caption") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Caption") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryWindowsQuickFixEngineeringPackage: Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering

func (InventoryWindowsQuickFixEngineeringPackage) MarshalJSON added in v0.36.0

type InventoryWindowsUpdatePackage added in v0.36.0

type InventoryWindowsUpdatePackage struct {
	// Categories: The categories that are associated with this update package.
	Categories []*InventoryWindowsUpdatePackageWindowsUpdateCategory `json:"categories,omitempty"`
	// Description: The localized description of the update package.
	Description string `json:"description,omitempty"`
	// KbArticleIds: A collection of Microsoft Knowledge Base article IDs that are
	// associated with the update package.
	KbArticleIds []string `json:"kbArticleIds,omitempty"`
	// LastDeploymentChangeTime: The last published date of the update, in (UTC)
	// date and time.
	LastDeploymentChangeTime string `json:"lastDeploymentChangeTime,omitempty"`
	// MoreInfoUrls: A collection of URLs that provide more information about the
	// update package.
	MoreInfoUrls []string `json:"moreInfoUrls,omitempty"`
	// RevisionNumber: The revision number of this update package.
	RevisionNumber int64 `json:"revisionNumber,omitempty"`
	// SupportUrl: A hyperlink to the language-specific support information for the
	// update.
	SupportUrl string `json:"supportUrl,omitempty"`
	// Title: The localized title of the update package.
	Title string `json:"title,omitempty"`
	// UpdateId: Gets the identifier of an update package. Stays the same across
	// revisions.
	UpdateId string `json:"updateId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Categories") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Categories") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryWindowsUpdatePackage: Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.

func (InventoryWindowsUpdatePackage) MarshalJSON added in v0.36.0

func (s InventoryWindowsUpdatePackage) MarshalJSON() ([]byte, error)

type InventoryWindowsUpdatePackageWindowsUpdateCategory added in v0.36.0

type InventoryWindowsUpdatePackageWindowsUpdateCategory struct {
	// Id: The identifier of the windows update category.
	Id string `json:"id,omitempty"`
	// Name: The name of the windows update category.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Id") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryWindowsUpdatePackageWindowsUpdateCategory: Categories specified by the Windows Update.

func (InventoryWindowsUpdatePackageWindowsUpdateCategory) MarshalJSON added in v0.36.0

type InventoryZypperPatch added in v0.36.0

type InventoryZypperPatch struct {
	// Category: The category of the patch.
	Category string `json:"category,omitempty"`
	// PatchName: The name of the patch.
	PatchName string `json:"patchName,omitempty"`
	// Severity: The severity specified for this patch
	Severity string `json:"severity,omitempty"`
	// Summary: Any summary information provided about this patch.
	Summary string `json:"summary,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Category") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Category") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InventoryZypperPatch: Details related to a Zypper Patch.

func (InventoryZypperPatch) MarshalJSON added in v0.36.0

func (s InventoryZypperPatch) MarshalJSON() ([]byte, error)

type ListInventoriesResponse added in v0.53.0

type ListInventoriesResponse struct {
	// Inventories: List of inventory objects.
	Inventories []*Inventory `json:"inventories,omitempty"`
	// NextPageToken: The pagination token to retrieve the next page of inventory
	// objects.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Inventories") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Inventories") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListInventoriesResponse: A response message for listing inventory data for all VMs in a specified location.

func (ListInventoriesResponse) MarshalJSON added in v0.53.0

func (s ListInventoriesResponse) MarshalJSON() ([]byte, error)

type ListOSPolicyAssignmentReportsResponse added in v0.59.0

type ListOSPolicyAssignmentReportsResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of OS policy
	// assignment report objects.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// OsPolicyAssignmentReports: List of OS policy assignment reports.
	OsPolicyAssignmentReports []*OSPolicyAssignmentReport `json:"osPolicyAssignmentReports,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOSPolicyAssignmentReportsResponse: A response message for listing OS Policy assignment reports including the page of results and page token.

func (ListOSPolicyAssignmentReportsResponse) MarshalJSON added in v0.59.0

func (s ListOSPolicyAssignmentReportsResponse) MarshalJSON() ([]byte, error)

type ListOSPolicyAssignmentRevisionsResponse added in v0.58.0

type ListOSPolicyAssignmentRevisionsResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of OS policy
	// assignment revisions.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// OsPolicyAssignments: The OS policy assignment revisions
	OsPolicyAssignments []*OSPolicyAssignment `json:"osPolicyAssignments,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOSPolicyAssignmentRevisionsResponse: A response message for listing all revisions for a OS policy assignment.

func (ListOSPolicyAssignmentRevisionsResponse) MarshalJSON added in v0.58.0

func (s ListOSPolicyAssignmentRevisionsResponse) MarshalJSON() ([]byte, error)

type ListOSPolicyAssignmentsResponse added in v0.58.0

type ListOSPolicyAssignmentsResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of OS policy
	// assignments.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// OsPolicyAssignments: The list of assignments
	OsPolicyAssignments []*OSPolicyAssignment `json:"osPolicyAssignments,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOSPolicyAssignmentsResponse: A response message for listing all assignments under given parent.

func (ListOSPolicyAssignmentsResponse) MarshalJSON added in v0.58.0

func (s ListOSPolicyAssignmentsResponse) MarshalJSON() ([]byte, error)

type ListPatchDeploymentsResponse

type ListPatchDeploymentsResponse struct {
	// NextPageToken: A pagination token that can be used to get the next page of
	// patch deployments.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// PatchDeployments: The list of patch deployments.
	PatchDeployments []*PatchDeployment `json:"patchDeployments,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListPatchDeploymentsResponse: A response message for listing patch deployments.

func (ListPatchDeploymentsResponse) MarshalJSON

func (s ListPatchDeploymentsResponse) MarshalJSON() ([]byte, error)

type ListPatchJobInstanceDetailsResponse

type ListPatchJobInstanceDetailsResponse struct {
	// NextPageToken: A pagination token that can be used to get the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// PatchJobInstanceDetails: A list of instance status.
	PatchJobInstanceDetails []*PatchJobInstanceDetails `json:"patchJobInstanceDetails,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListPatchJobInstanceDetailsResponse: A response message for listing the instances details for a patch job.

func (ListPatchJobInstanceDetailsResponse) MarshalJSON

func (s ListPatchJobInstanceDetailsResponse) MarshalJSON() ([]byte, error)

type ListPatchJobsResponse

type ListPatchJobsResponse struct {
	// NextPageToken: A pagination token that can be used to get the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// PatchJobs: The list of patch jobs.
	PatchJobs []*PatchJob `json:"patchJobs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListPatchJobsResponse: A response message for listing patch jobs.

func (ListPatchJobsResponse) MarshalJSON

func (s ListPatchJobsResponse) MarshalJSON() ([]byte, error)

type ListVulnerabilityReportsResponse added in v0.53.0

type ListVulnerabilityReportsResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of
	// vulnerabilityReports object.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// VulnerabilityReports: List of vulnerabilityReport objects.
	VulnerabilityReports []*VulnerabilityReport `json:"vulnerabilityReports,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListVulnerabilityReportsResponse: A response message for listing vulnerability reports for all VM instances in the specified location.

func (ListVulnerabilityReportsResponse) MarshalJSON added in v0.53.0

func (s ListVulnerabilityReportsResponse) MarshalJSON() ([]byte, error)

type MonthlySchedule

type MonthlySchedule struct {
	// MonthDay: Required. One day of the month. 1-31 indicates the 1st to the 31st
	// day. -1 indicates the last day of the month. Months without the target day
	// will be skipped. For example, a schedule to run "every month on the 31st"
	// will not run in February, April, June, etc.
	MonthDay int64 `json:"monthDay,omitempty"`
	// WeekDayOfMonth: Required. Week day in a month.
	WeekDayOfMonth *WeekDayOfMonth `json:"weekDayOfMonth,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MonthDay") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MonthDay") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MonthlySchedule: Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".

func (MonthlySchedule) MarshalJSON

func (s MonthlySchedule) MarshalJSON() ([]byte, error)

type OSPolicy added in v0.58.0

type OSPolicy struct {
	// AllowNoResourceGroupMatch: This flag determines the OS policy compliance
	// status when none of the resource groups within the policy are applicable for
	// a VM. Set this value to `true` if the policy needs to be reported as
	// compliant even if the policy has nothing to validate or enforce.
	AllowNoResourceGroupMatch bool `json:"allowNoResourceGroupMatch,omitempty"`
	// Description: Policy description. Length of the description is limited to
	// 1024 characters.
	Description string `json:"description,omitempty"`
	// Id: Required. The id of the OS policy with the following restrictions: *
	// Must contain only lowercase letters, numbers, and hyphens. * Must start with
	// a letter. * Must be between 1-63 characters. * Must end with a number or a
	// letter. * Must be unique within the assignment.
	Id string `json:"id,omitempty"`
	// Mode: Required. Policy mode
	//
	// Possible values:
	//   "MODE_UNSPECIFIED" - Invalid mode
	//   "VALIDATION" - This mode checks if the configuration resources in the
	// policy are in their desired state. No actions are performed if they are not
	// in the desired state. This mode is used for reporting purposes.
	//   "ENFORCEMENT" - This mode checks if the configuration resources in the
	// policy are in their desired state, and if not, enforces the desired state.
	Mode string `json:"mode,omitempty"`
	// ResourceGroups: Required. List of resource groups for the policy. For a
	// particular VM, resource groups are evaluated in the order specified and the
	// first resource group that is applicable is selected and the rest are
	// ignored. If none of the resource groups are applicable for a VM, the VM is
	// considered to be non-compliant w.r.t this policy. This behavior can be
	// toggled by the flag `allow_no_resource_group_match`
	ResourceGroups []*OSPolicyResourceGroup `json:"resourceGroups,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowNoResourceGroupMatch")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowNoResourceGroupMatch") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicy: An OS policy defines the desired state configuration for a VM.

func (OSPolicy) MarshalJSON added in v0.58.0

func (s OSPolicy) MarshalJSON() ([]byte, error)

type OSPolicyAssignment added in v0.58.0

type OSPolicyAssignment struct {
	// Baseline: Output only. Indicates that this revision has been successfully
	// rolled out in this zone and new VMs will be assigned OS policies from this
	// revision. For a given OS policy assignment, there is only one revision with
	// a value of `true` for this field.
	Baseline bool `json:"baseline,omitempty"`
	// Deleted: Output only. Indicates that this revision deletes the OS policy
	// assignment.
	Deleted bool `json:"deleted,omitempty"`
	// Description: OS policy assignment description. Length of the description is
	// limited to 1024 characters.
	Description string `json:"description,omitempty"`
	// Etag: The etag for this OS policy assignment. If this is provided on update,
	// it must match the server's etag.
	Etag string `json:"etag,omitempty"`
	// InstanceFilter: Required. Filter to select VMs.
	InstanceFilter *OSPolicyAssignmentInstanceFilter `json:"instanceFilter,omitempty"`
	// Name: Resource name. Format:
	// `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_polic
	// y_assignment_id}` This field is ignored when you create an OS policy
	// assignment.
	Name string `json:"name,omitempty"`
	// OsPolicies: Required. List of OS policies to be applied to the VMs.
	OsPolicies []*OSPolicy `json:"osPolicies,omitempty"`
	// Reconciling: Output only. Indicates that reconciliation is in progress for
	// the revision. This value is `true` when the `rollout_state` is one of: *
	// IN_PROGRESS * CANCELLING
	Reconciling bool `json:"reconciling,omitempty"`
	// RevisionCreateTime: Output only. The timestamp that the revision was
	// created.
	RevisionCreateTime string `json:"revisionCreateTime,omitempty"`
	// RevisionId: Output only. The assignment revision ID A new revision is
	// committed whenever a rollout is triggered for a OS policy assignment
	RevisionId string `json:"revisionId,omitempty"`
	// Rollout: Required. Rollout to deploy the OS policy assignment. A rollout is
	// triggered in the following situations: 1) OSPolicyAssignment is created. 2)
	// OSPolicyAssignment is updated and the update contains changes to one of the
	// following fields: - instance_filter - os_policies 3) OSPolicyAssignment is
	// deleted.
	Rollout *OSPolicyAssignmentRollout `json:"rollout,omitempty"`
	// RolloutState: Output only. OS policy assignment rollout state
	//
	// Possible values:
	//   "ROLLOUT_STATE_UNSPECIFIED" - Invalid value
	//   "IN_PROGRESS" - The rollout is in progress.
	//   "CANCELLING" - The rollout is being cancelled.
	//   "CANCELLED" - The rollout is cancelled.
	//   "SUCCEEDED" - The rollout has completed successfully.
	RolloutState string `json:"rolloutState,omitempty"`
	// Uid: Output only. Server generated unique id for the OS policy assignment
	// resource.
	Uid string `json:"uid,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Baseline") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Baseline") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignment: OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information about the OS policy resource definitions and examples, see OS policy and OS policy assignment (https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).

func (OSPolicyAssignment) MarshalJSON added in v0.58.0

func (s OSPolicyAssignment) MarshalJSON() ([]byte, error)

type OSPolicyAssignmentInstanceFilter added in v0.58.0

type OSPolicyAssignmentInstanceFilter struct {
	// All: Target all VMs in the project. If true, no other criteria is permitted.
	All bool `json:"all,omitempty"`
	// ExclusionLabels: List of label sets used for VM exclusion. If the list has
	// more than one label set, the VM is excluded if any of the label sets are
	// applicable for the VM.
	ExclusionLabels []*OSPolicyAssignmentLabelSet `json:"exclusionLabels,omitempty"`
	// InclusionLabels: List of label sets used for VM inclusion. If the list has
	// more than one `LabelSet`, the VM is included if any of the label sets are
	// applicable for the VM.
	InclusionLabels []*OSPolicyAssignmentLabelSet `json:"inclusionLabels,omitempty"`
	// Inventories: List of inventories to select VMs. A VM is selected if its
	// inventory data matches at least one of the following inventories.
	Inventories []*OSPolicyAssignmentInstanceFilterInventory `json:"inventories,omitempty"`
	// ForceSendFields is a list of field names (e.g. "All") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "All") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentInstanceFilter: Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.

func (OSPolicyAssignmentInstanceFilter) MarshalJSON added in v0.58.0

func (s OSPolicyAssignmentInstanceFilter) MarshalJSON() ([]byte, error)

type OSPolicyAssignmentInstanceFilterInventory added in v0.58.0

type OSPolicyAssignmentInstanceFilterInventory struct {
	// OsShortName: Required. The OS short name
	OsShortName string `json:"osShortName,omitempty"`
	// OsVersion: The OS version Prefix matches are supported if asterisk(*) is
	// provided as the last character. For example, to match all versions with a
	// major version of `7`, specify the following value for this field `7.*` An
	// empty string matches all OS versions.
	OsVersion string `json:"osVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OsShortName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OsShortName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentInstanceFilterInventory: VM inventory details.

func (OSPolicyAssignmentInstanceFilterInventory) MarshalJSON added in v0.58.0

type OSPolicyAssignmentLabelSet added in v0.58.0

type OSPolicyAssignmentLabelSet struct {
	// Labels: Labels are identified by key/value pairs in this map. A VM should
	// contain all the key/value pairs specified in this map to be selected.
	Labels map[string]string `json:"labels,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentLabelSet: Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present.

func (OSPolicyAssignmentLabelSet) MarshalJSON added in v0.58.0

func (s OSPolicyAssignmentLabelSet) MarshalJSON() ([]byte, error)

type OSPolicyAssignmentOperationMetadata added in v0.46.0

type OSPolicyAssignmentOperationMetadata struct {
	// ApiMethod: The OS policy assignment API method.
	//
	// Possible values:
	//   "API_METHOD_UNSPECIFIED" - Invalid value
	//   "CREATE" - Create OS policy assignment API method
	//   "UPDATE" - Update OS policy assignment API method
	//   "DELETE" - Delete OS policy assignment API method
	ApiMethod string `json:"apiMethod,omitempty"`
	// OsPolicyAssignment: Reference to the `OSPolicyAssignment` API resource.
	// Format:
	// `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_polic
	// y_assignment_id@revision_id}`
	OsPolicyAssignment string `json:"osPolicyAssignment,omitempty"`
	// RolloutStartTime: Rollout start time
	RolloutStartTime string `json:"rolloutStartTime,omitempty"`
	// RolloutState: State of the rollout
	//
	// Possible values:
	//   "ROLLOUT_STATE_UNSPECIFIED" - Invalid value
	//   "IN_PROGRESS" - The rollout is in progress.
	//   "CANCELLING" - The rollout is being cancelled.
	//   "CANCELLED" - The rollout is cancelled.
	//   "SUCCEEDED" - The rollout has completed successfully.
	RolloutState string `json:"rolloutState,omitempty"`
	// RolloutUpdateTime: Rollout update time
	RolloutUpdateTime string `json:"rolloutUpdateTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiMethod") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiMethod") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentOperationMetadata: OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.

func (OSPolicyAssignmentOperationMetadata) MarshalJSON added in v0.46.0

func (s OSPolicyAssignmentOperationMetadata) MarshalJSON() ([]byte, error)

type OSPolicyAssignmentReport added in v0.59.0

type OSPolicyAssignmentReport struct {
	// Instance: The Compute Engine VM instance name.
	Instance string `json:"instance,omitempty"`
	// LastRunId: Unique identifier of the last attempted run to apply the OS
	// policies associated with this assignment on the VM. This ID is logged by the
	// OS Config agent while applying the OS policies associated with this
	// assignment on the VM. NOTE: If the service is unable to successfully connect
	// to the agent for this run, then this id will not be available in the agent
	// logs.
	LastRunId string `json:"lastRunId,omitempty"`
	// Name: The `OSPolicyAssignmentReport` API resource name. Format:
	// `projects/{project_number}/locations/{location}/instances/{instance_id}/osPol
	// icyAssignments/{os_policy_assignment_id}/report`
	Name string `json:"name,omitempty"`
	// OsPolicyAssignment: Reference to the `OSPolicyAssignment` API resource that
	// the `OSPolicy` belongs to. Format:
	// `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_polic
	// y_assignment_id@revision_id}`
	OsPolicyAssignment string `json:"osPolicyAssignment,omitempty"`
	// OsPolicyCompliances: Compliance data for each `OSPolicy` that is applied to
	// the VM.
	OsPolicyCompliances []*OSPolicyAssignmentReportOSPolicyCompliance `json:"osPolicyCompliances,omitempty"`
	// UpdateTime: Timestamp for when the report was last generated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Instance") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Instance") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentReport: A report of the OS policy assignment status for a given instance.

func (OSPolicyAssignmentReport) MarshalJSON added in v0.59.0

func (s OSPolicyAssignmentReport) MarshalJSON() ([]byte, error)

type OSPolicyAssignmentReportOSPolicyCompliance added in v0.59.0

type OSPolicyAssignmentReportOSPolicyCompliance struct {
	// ComplianceState: The compliance state of the OS policy.
	//
	// Possible values:
	//   "UNKNOWN" - The policy is in an unknown compliance state. Refer to the
	// field `compliance_state_reason` to learn the exact reason for the policy to
	// be in this compliance state.
	//   "COMPLIANT" - Policy is compliant. The policy is compliant if all the
	// underlying resources are also compliant.
	//   "NON_COMPLIANT" - Policy is non-compliant. The policy is non-compliant if
	// one or more underlying resources are non-compliant.
	ComplianceState string `json:"complianceState,omitempty"`
	// ComplianceStateReason: The reason for the OS policy to be in an unknown
	// compliance state. This field is always populated when `compliance_state` is
	// `UNKNOWN`. If populated, the field can contain one of the following values:
	// * `vm-not-running`: The VM was not running. *
	// `os-policies-not-supported-by-agent`: The version of the OS Config agent
	// running on the VM does not support running OS policies. *
	// `no-agent-detected`: The OS Config agent is not detected for the VM. *
	// `resource-execution-errors`: The OS Config agent encountered errors while
	// executing one or more resources in the policy. See
	// `os_policy_resource_compliances` for details. * `task-timeout`: The task
	// sent to the agent to apply the policy timed out. * `unexpected-agent-state`:
	// The OS Config agent did not report the final status of the task that
	// attempted to apply the policy. Instead, the agent unexpectedly started
	// working on a different task. This mostly happens when the agent or VM
	// unexpectedly restarts while applying OS policies. *
	// `internal-service-errors`: Internal service errors were encountered while
	// attempting to apply the policy. * `os-policy-execution-pending`: OS policy
	// was assigned to the given VM, but was not executed yet. Typically this is a
	// transient condition that will go away after the next policy execution cycle.
	ComplianceStateReason string `json:"complianceStateReason,omitempty"`
	// OsPolicyId: The OS policy id
	OsPolicyId string `json:"osPolicyId,omitempty"`
	// OsPolicyResourceCompliances: Compliance data for each resource within the
	// policy that is applied to the VM.
	OsPolicyResourceCompliances []*OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance `json:"osPolicyResourceCompliances,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ComplianceState") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ComplianceState") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentReportOSPolicyCompliance: Compliance data for an OS policy

func (OSPolicyAssignmentReportOSPolicyCompliance) MarshalJSON added in v0.59.0

type OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance added in v0.59.0

type OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance struct {
	// ComplianceState: The compliance state of the resource.
	//
	// Possible values:
	//   "UNKNOWN" - The resource is in an unknown compliance state. To get more
	// details about why the policy is in this state, review the output of the
	// `compliance_state_reason` field.
	//   "COMPLIANT" - Resource is compliant.
	//   "NON_COMPLIANT" - Resource is non-compliant.
	ComplianceState string `json:"complianceState,omitempty"`
	// ComplianceStateReason: A reason for the resource to be in the given
	// compliance state. This field is always populated when `compliance_state` is
	// `UNKNOWN`. The following values are supported when `compliance_state ==
	// UNKNOWN` * `execution-errors`: Errors were encountered by the agent while
	// executing the resource and the compliance state couldn't be determined. *
	// `execution-skipped-by-agent`: Resource execution was skipped by the agent
	// because errors were encountered while executing prior resources in the OS
	// policy. * `os-policy-execution-attempt-failed`: The execution of the OS
	// policy containing this resource failed and the compliance state couldn't be
	// determined. * `os-policy-execution-pending`: OS policy that owns this
	// resource was assigned to the given VM, but was not executed yet.
	ComplianceStateReason string `json:"complianceStateReason,omitempty"`
	// ConfigSteps: Ordered list of configuration completed by the agent for the OS
	// policy resource.
	ConfigSteps []*OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep `json:"configSteps,omitempty"`
	// ExecResourceOutput: ExecResource specific output.
	ExecResourceOutput *OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput `json:"execResourceOutput,omitempty"`
	// OsPolicyResourceId: The ID of the OS policy resource.
	OsPolicyResourceId string `json:"osPolicyResourceId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ComplianceState") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ComplianceState") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance: Compliance data for an OS policy resource.

func (OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance) MarshalJSON added in v0.59.0

type OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput added in v0.59.0

type OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput struct {
	// EnforcementOutput: Output from enforcement phase output file (if run).
	// Output size is limited to 100K bytes.
	EnforcementOutput string `json:"enforcementOutput,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnforcementOutput") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnforcementOutput") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResou rceOutput: ExecResource specific output.

func (OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput) MarshalJSON added in v0.59.0

type OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep added in v0.59.0

type OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep struct {
	// ErrorMessage: An error message recorded during the execution of this step.
	// Only populated if errors were encountered during this step execution.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// Type: Configuration step type.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Default value. This value is unused.
	//   "VALIDATION" - Checks for resource conflicts such as schema errors.
	//   "DESIRED_STATE_CHECK" - Checks the current status of the desired state for
	// a resource.
	//   "DESIRED_STATE_ENFORCEMENT" - Enforces the desired state for a resource
	// that is not in desired state.
	//   "DESIRED_STATE_CHECK_POST_ENFORCEMENT" - Re-checks the status of the
	// desired state. This check is done for a resource after the enforcement of
	// all OS policies. This step is used to determine the final desired state
	// status for the resource. It accounts for any resources that might have
	// drifted from their desired state due to side effects from executing other
	// resources.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ErrorMessage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ErrorMessage") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyR esourceConfigStep: Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state.

func (OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep) MarshalJSON added in v0.59.0

type OSPolicyAssignmentRollout added in v0.58.0

type OSPolicyAssignmentRollout struct {
	// DisruptionBudget: Required. The maximum number (or percentage) of VMs per
	// zone to disrupt at any given moment.
	DisruptionBudget *FixedOrPercent `json:"disruptionBudget,omitempty"`
	// MinWaitDuration: Required. This determines the minimum duration of time to
	// wait after the configuration changes are applied through the current
	// rollout. A VM continues to count towards the `disruption_budget` at least
	// until this duration of time has passed after configuration changes are
	// applied.
	MinWaitDuration string `json:"minWaitDuration,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisruptionBudget") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisruptionBudget") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyAssignmentRollout: Message to configure the rollout at the zonal level for the OS policy assignment.

func (OSPolicyAssignmentRollout) MarshalJSON added in v0.58.0

func (s OSPolicyAssignmentRollout) MarshalJSON() ([]byte, error)

type OSPolicyInventoryFilter added in v0.58.0

type OSPolicyInventoryFilter struct {
	// OsShortName: Required. The OS short name
	OsShortName string `json:"osShortName,omitempty"`
	// OsVersion: The OS version Prefix matches are supported if asterisk(*) is
	// provided as the last character. For example, to match all versions with a
	// major version of `7`, specify the following value for this field `7.*` An
	// empty string matches all OS versions.
	OsVersion string `json:"osVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OsShortName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OsShortName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyInventoryFilter: Filtering criteria to select VMs based on inventory details.

func (OSPolicyInventoryFilter) MarshalJSON added in v0.58.0

func (s OSPolicyInventoryFilter) MarshalJSON() ([]byte, error)

type OSPolicyResource added in v0.58.0

type OSPolicyResource struct {
	// Exec: Exec resource
	Exec *OSPolicyResourceExecResource `json:"exec,omitempty"`
	// File: File resource
	File *OSPolicyResourceFileResource `json:"file,omitempty"`
	// Id: Required. The id of the resource with the following restrictions: * Must
	// contain only lowercase letters, numbers, and hyphens. * Must start with a
	// letter. * Must be between 1-63 characters. * Must end with a number or a
	// letter. * Must be unique within the OS policy.
	Id string `json:"id,omitempty"`
	// Pkg: Package resource
	Pkg *OSPolicyResourcePackageResource `json:"pkg,omitempty"`
	// Repository: Package repository resource
	Repository *OSPolicyResourceRepositoryResource `json:"repository,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Exec") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Exec") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResource: An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

func (OSPolicyResource) MarshalJSON added in v0.58.0

func (s OSPolicyResource) MarshalJSON() ([]byte, error)

type OSPolicyResourceExecResource added in v0.58.0

type OSPolicyResourceExecResource struct {
	// Enforce: What to run to bring this resource into the desired state. An exit
	// code of 100 indicates "success", any other exit code indicates a failure
	// running enforce.
	Enforce *OSPolicyResourceExecResourceExec `json:"enforce,omitempty"`
	// Validate: Required. What to run to validate this resource is in the desired
	// state. An exit code of 100 indicates "in desired state", and exit code of
	// 101 indicates "not in desired state". Any other exit code indicates a
	// failure running validate.
	Validate *OSPolicyResourceExecResourceExec `json:"validate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Enforce") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Enforce") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceExecResource: A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen.

func (OSPolicyResourceExecResource) MarshalJSON added in v0.58.0

func (s OSPolicyResourceExecResource) MarshalJSON() ([]byte, error)

type OSPolicyResourceExecResourceExec added in v0.58.0

type OSPolicyResourceExecResourceExec struct {
	// Args: Optional arguments to pass to the source during execution.
	Args []string `json:"args,omitempty"`
	// File: A remote or local file.
	File *OSPolicyResourceFile `json:"file,omitempty"`
	// Interpreter: Required. The script interpreter to use.
	//
	// Possible values:
	//   "INTERPRETER_UNSPECIFIED" - Invalid value, the request will return
	// validation error.
	//   "NONE" - If an interpreter is not specified, the source is executed
	// directly. This execution, without an interpreter, only succeeds for
	// executables and scripts that have shebang lines.
	//   "SHELL" - Indicates that the script runs with `/bin/sh` on Linux and
	// `cmd.exe` on Windows.
	//   "POWERSHELL" - Indicates that the script runs with PowerShell.
	Interpreter string `json:"interpreter,omitempty"`
	// OutputFilePath: Only recorded for enforce Exec. Path to an output file (that
	// is created by this Exec) whose content will be recorded in
	// OSPolicyResourceCompliance after a successful run. Absence or failure to
	// read this file will result in this ExecResource being non-compliant. Output
	// file size is limited to 500K bytes.
	OutputFilePath string `json:"outputFilePath,omitempty"`
	// Script: An inline script. The size of the script is limited to 32KiB.
	Script string `json:"script,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Args") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceExecResourceExec: A file or script to execute.

func (OSPolicyResourceExecResourceExec) MarshalJSON added in v0.58.0

func (s OSPolicyResourceExecResourceExec) MarshalJSON() ([]byte, error)

type OSPolicyResourceFile added in v0.58.0

type OSPolicyResourceFile struct {
	// AllowInsecure: Defaults to false. When false, files are subject to
	// validations based on the file type: Remote: A checksum must be specified.
	// Cloud Storage: An object generation number must be specified.
	AllowInsecure bool `json:"allowInsecure,omitempty"`
	// Gcs: A Cloud Storage object.
	Gcs *OSPolicyResourceFileGcs `json:"gcs,omitempty"`
	// LocalPath: A local path within the VM to use.
	LocalPath string `json:"localPath,omitempty"`
	// Remote: A generic remote file.
	Remote *OSPolicyResourceFileRemote `json:"remote,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowInsecure") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowInsecure") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceFile: A remote or local file.

func (OSPolicyResourceFile) MarshalJSON added in v0.58.0

func (s OSPolicyResourceFile) MarshalJSON() ([]byte, error)

type OSPolicyResourceFileGcs added in v0.58.0

type OSPolicyResourceFileGcs struct {
	// Bucket: Required. Bucket of the Cloud Storage object.
	Bucket string `json:"bucket,omitempty"`
	// Generation: Generation number of the Cloud Storage object.
	Generation int64 `json:"generation,omitempty,string"`
	// Object: Required. Name of the Cloud Storage object.
	Object string `json:"object,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Bucket") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Bucket") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceFileGcs: Specifies a file available as a Cloud Storage Object.

func (OSPolicyResourceFileGcs) MarshalJSON added in v0.58.0

func (s OSPolicyResourceFileGcs) MarshalJSON() ([]byte, error)

type OSPolicyResourceFileRemote added in v0.58.0

type OSPolicyResourceFileRemote struct {
	// Sha256Checksum: SHA256 checksum of the remote file.
	Sha256Checksum string `json:"sha256Checksum,omitempty"`
	// Uri: Required. URI from which to fetch the object. It should contain both
	// the protocol and path following the format `{protocol}://{location}`.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Sha256Checksum") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Sha256Checksum") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceFileRemote: Specifies a file available via some URI.

func (OSPolicyResourceFileRemote) MarshalJSON added in v0.58.0

func (s OSPolicyResourceFileRemote) MarshalJSON() ([]byte, error)

type OSPolicyResourceFileResource added in v0.58.0

type OSPolicyResourceFileResource struct {
	// Content: A a file with this content. The size of the content is limited to
	// 32KiB.
	Content string `json:"content,omitempty"`
	// File: A remote or local source.
	File *OSPolicyResourceFile `json:"file,omitempty"`
	// Path: Required. The absolute path of the file within the VM.
	Path string `json:"path,omitempty"`
	// Permissions: Consists of three octal digits which represent, in order, the
	// permissions of the owner, group, and other users for the file (similarly to
	// the numeric mode used in the linux chmod utility). Each digit represents a
	// three bit number with the 4 bit corresponding to the read permissions, the 2
	// bit corresponds to the write bit, and the one bit corresponds to the execute
	// permission. Default behavior is 755. Below are some examples of permissions
	// and their associated values: read, write, and execute: 7 read and execute: 5
	// read and write: 6 read only: 4
	Permissions string `json:"permissions,omitempty"`
	// State: Required. Desired state of the file.
	//
	// Possible values:
	//   "DESIRED_STATE_UNSPECIFIED" - Unspecified is invalid.
	//   "PRESENT" - Ensure file at path is present.
	//   "ABSENT" - Ensure file at path is absent.
	//   "CONTENTS_MATCH" - Ensure the contents of the file at path matches. If the
	// file does not exist it will be created.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Content") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Content") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceFileResource: A resource that manages the state of a file.

func (OSPolicyResourceFileResource) MarshalJSON added in v0.58.0

func (s OSPolicyResourceFileResource) MarshalJSON() ([]byte, error)

type OSPolicyResourceGroup added in v0.58.0

type OSPolicyResourceGroup struct {
	// InventoryFilters: List of inventory filters for the resource group. The
	// resources in this resource group are applied to the target VM if it
	// satisfies at least one of the following inventory filters. For example, to
	// apply this resource group to VMs running either `RHEL` or `CentOS` operating
	// systems, specify 2 items for the list with following values:
	// inventory_filters[0].os_short_name='rhel' and
	// inventory_filters[1].os_short_name='centos' If the list is empty, this
	// resource group will be applied to the target VM unconditionally.
	InventoryFilters []*OSPolicyInventoryFilter `json:"inventoryFilters,omitempty"`
	// Resources: Required. List of resources configured for this resource group.
	// The resources are executed in the exact order specified here.
	Resources []*OSPolicyResource `json:"resources,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InventoryFilters") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InventoryFilters") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceGroup: Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group.

func (OSPolicyResourceGroup) MarshalJSON added in v0.58.0

func (s OSPolicyResourceGroup) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResource added in v0.58.0

type OSPolicyResourcePackageResource struct {
	// Apt: A package managed by Apt.
	Apt *OSPolicyResourcePackageResourceAPT `json:"apt,omitempty"`
	// Deb: A deb package file.
	Deb *OSPolicyResourcePackageResourceDeb `json:"deb,omitempty"`
	// DesiredState: Required. The desired state the agent should maintain for this
	// package.
	//
	// Possible values:
	//   "DESIRED_STATE_UNSPECIFIED" - Unspecified is invalid.
	//   "INSTALLED" - Ensure that the package is installed.
	//   "REMOVED" - The agent ensures that the package is not installed and
	// uninstalls it if detected.
	DesiredState string `json:"desiredState,omitempty"`
	// Googet: A package managed by GooGet.
	Googet *OSPolicyResourcePackageResourceGooGet `json:"googet,omitempty"`
	// Msi: An MSI package.
	Msi *OSPolicyResourcePackageResourceMSI `json:"msi,omitempty"`
	// Rpm: An rpm package file.
	Rpm *OSPolicyResourcePackageResourceRPM `json:"rpm,omitempty"`
	// Yum: A package managed by YUM.
	Yum *OSPolicyResourcePackageResourceYUM `json:"yum,omitempty"`
	// Zypper: A package managed by Zypper.
	Zypper *OSPolicyResourcePackageResourceZypper `json:"zypper,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Apt") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Apt") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResource: A resource that manages a system package.

func (OSPolicyResourcePackageResource) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResource) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceAPT added in v0.58.0

type OSPolicyResourcePackageResourceAPT struct {
	// Name: Required. Package name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceAPT: A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]`

func (OSPolicyResourcePackageResourceAPT) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceAPT) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceDeb added in v0.58.0

type OSPolicyResourcePackageResourceDeb struct {
	// PullDeps: Whether dependencies should also be installed. - install when
	// false: `dpkg -i package` - install when true: `apt-get update && apt-get -y
	// install package.deb`
	PullDeps bool `json:"pullDeps,omitempty"`
	// Source: Required. A deb package.
	Source *OSPolicyResourceFile `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PullDeps") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PullDeps") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceDeb: A deb package file. dpkg packages only support INSTALLED state.

func (OSPolicyResourcePackageResourceDeb) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceDeb) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceGooGet added in v0.58.0

type OSPolicyResourcePackageResourceGooGet struct {
	// Name: Required. Package name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceGooGet: A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package`

func (OSPolicyResourcePackageResourceGooGet) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceGooGet) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceMSI added in v0.58.0

type OSPolicyResourcePackageResourceMSI struct {
	// Properties: Additional properties to use during installation. This should be
	// in the format of Property=Setting. Appended to the defaults of
	// `ACTION=INSTALL REBOOT=ReallySuppress`.
	Properties []string `json:"properties,omitempty"`
	// Source: Required. The MSI package.
	Source *OSPolicyResourceFile `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Properties") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Properties") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceMSI: An MSI package. MSI packages only support INSTALLED state.

func (OSPolicyResourcePackageResourceMSI) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceMSI) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceRPM added in v0.58.0

type OSPolicyResourcePackageResourceRPM struct {
	// PullDeps: Whether dependencies should also be installed. - install when
	// false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum
	// -y install package.rpm` or `zypper -y install package.rpm`
	PullDeps bool `json:"pullDeps,omitempty"`
	// Source: Required. An rpm package.
	Source *OSPolicyResourceFile `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PullDeps") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PullDeps") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceRPM: An RPM package file. RPM packages only support INSTALLED state.

func (OSPolicyResourcePackageResourceRPM) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceRPM) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceYUM added in v0.58.0

type OSPolicyResourcePackageResourceYUM struct {
	// Name: Required. Package name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceYUM: A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package`

func (OSPolicyResourcePackageResourceYUM) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceYUM) MarshalJSON() ([]byte, error)

type OSPolicyResourcePackageResourceZypper added in v0.58.0

type OSPolicyResourcePackageResourceZypper struct {
	// Name: Required. Package name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourcePackageResourceZypper: A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package`

func (OSPolicyResourcePackageResourceZypper) MarshalJSON added in v0.58.0

func (s OSPolicyResourcePackageResourceZypper) MarshalJSON() ([]byte, error)

type OSPolicyResourceRepositoryResource added in v0.58.0

type OSPolicyResourceRepositoryResource struct {
	// Apt: An Apt Repository.
	Apt *OSPolicyResourceRepositoryResourceAptRepository `json:"apt,omitempty"`
	// Goo: A Goo Repository.
	Goo *OSPolicyResourceRepositoryResourceGooRepository `json:"goo,omitempty"`
	// Yum: A Yum Repository.
	Yum *OSPolicyResourceRepositoryResourceYumRepository `json:"yum,omitempty"`
	// Zypper: A Zypper Repository.
	Zypper *OSPolicyResourceRepositoryResourceZypperRepository `json:"zypper,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Apt") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Apt") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceRepositoryResource: A resource that manages a package repository.

func (OSPolicyResourceRepositoryResource) MarshalJSON added in v0.58.0

func (s OSPolicyResourceRepositoryResource) MarshalJSON() ([]byte, error)

type OSPolicyResourceRepositoryResourceAptRepository added in v0.58.0

type OSPolicyResourceRepositoryResourceAptRepository struct {
	// ArchiveType: Required. Type of archive files in this repository.
	//
	// Possible values:
	//   "ARCHIVE_TYPE_UNSPECIFIED" - Unspecified is invalid.
	//   "DEB" - Deb indicates that the archive contains binary files.
	//   "DEB_SRC" - Deb-src indicates that the archive contains source files.
	ArchiveType string `json:"archiveType,omitempty"`
	// Components: Required. List of components for this repository. Must contain
	// at least one item.
	Components []string `json:"components,omitempty"`
	// Distribution: Required. Distribution of this repository.
	Distribution string `json:"distribution,omitempty"`
	// GpgKey: URI of the key file for this repository. The agent maintains a
	// keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`.
	GpgKey string `json:"gpgKey,omitempty"`
	// Uri: Required. URI for this repository.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ArchiveType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ArchiveType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceRepositoryResourceAptRepository: Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`.

func (OSPolicyResourceRepositoryResourceAptRepository) MarshalJSON added in v0.58.0

type OSPolicyResourceRepositoryResourceGooRepository added in v0.58.0

type OSPolicyResourceRepositoryResourceGooRepository struct {
	// Name: Required. The name of the repository.
	Name string `json:"name,omitempty"`
	// Url: Required. The url of the repository.
	Url string `json:"url,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceRepositoryResourceGooRepository: Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`.

func (OSPolicyResourceRepositoryResourceGooRepository) MarshalJSON added in v0.58.0

type OSPolicyResourceRepositoryResourceYumRepository added in v0.58.0

type OSPolicyResourceRepositoryResourceYumRepository struct {
	// BaseUrl: Required. The location of the repository directory.
	BaseUrl string `json:"baseUrl,omitempty"`
	// DisplayName: The display name of the repository.
	DisplayName string `json:"displayName,omitempty"`
	// GpgKeys: URIs of GPG keys.
	GpgKeys []string `json:"gpgKeys,omitempty"`
	// Id: Required. A one word, unique name for this repository. This is the `repo
	// id` in the yum config file and also the `display_name` if `display_name` is
	// omitted. This id is also used as the unique identifier when checking for
	// resource conflicts.
	Id string `json:"id,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BaseUrl") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BaseUrl") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceRepositoryResourceYumRepository: Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`.

func (OSPolicyResourceRepositoryResourceYumRepository) MarshalJSON added in v0.58.0

type OSPolicyResourceRepositoryResourceZypperRepository added in v0.58.0

type OSPolicyResourceRepositoryResourceZypperRepository struct {
	// BaseUrl: Required. The location of the repository directory.
	BaseUrl string `json:"baseUrl,omitempty"`
	// DisplayName: The display name of the repository.
	DisplayName string `json:"displayName,omitempty"`
	// GpgKeys: URIs of GPG keys.
	GpgKeys []string `json:"gpgKeys,omitempty"`
	// Id: Required. A one word, unique name for this repository. This is the `repo
	// id` in the zypper config file and also the `display_name` if `display_name`
	// is omitted. This id is also used as the unique identifier when checking for
	// GuestPolicy conflicts.
	Id string `json:"id,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BaseUrl") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BaseUrl") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OSPolicyResourceRepositoryResourceZypperRepository: Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`.

func (OSPolicyResourceRepositoryResourceZypperRepository) MarshalJSON added in v0.58.0

type OneTimeSchedule

type OneTimeSchedule struct {
	// ExecuteTime: Required. The desired patch job execution time.
	ExecuteTime string `json:"executeTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExecuteTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExecuteTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OneTimeSchedule: Sets the time for a one time patch deployment. Timestamp is in RFC3339 (https://www.ietf.org/rfc/rfc3339.txt) text format.

func (OneTimeSchedule) MarshalJSON

func (s OneTimeSchedule) MarshalJSON() ([]byte, error)

type Operation added in v0.43.0

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON added in v0.43.0

func (s Operation) MarshalJSON() ([]byte, error)

type PatchConfig

type PatchConfig struct {
	// Apt: Apt update settings. Use this setting to override the default `apt`
	// patch rules.
	Apt *AptSettings `json:"apt,omitempty"`
	// Goo: Goo update settings. Use this setting to override the default `goo`
	// patch rules.
	Goo *GooSettings `json:"goo,omitempty"`
	// MigInstancesAllowed: Allows the patch job to run on Managed instance groups
	// (MIGs).
	MigInstancesAllowed bool `json:"migInstancesAllowed,omitempty"`
	// PostStep: The `ExecStep` to run after the patch update.
	PostStep *ExecStep `json:"postStep,omitempty"`
	// PreStep: The `ExecStep` to run before the patch update.
	PreStep *ExecStep `json:"preStep,omitempty"`
	// RebootConfig: Post-patch reboot settings.
	//
	// Possible values:
	//   "REBOOT_CONFIG_UNSPECIFIED" - The default behavior is DEFAULT.
	//   "DEFAULT" - The agent decides if a reboot is necessary by checking signals
	// such as registry keys on Windows or `/var/run/reboot-required` on APT based
	// systems. On RPM based systems, a set of core system package install times
	// are compared with system boot time.
	//   "ALWAYS" - Always reboot the machine after the update completes.
	//   "NEVER" - Never reboot the machine after the update completes.
	RebootConfig string `json:"rebootConfig,omitempty"`
	// WindowsUpdate: Windows update settings. Use this override the default
	// windows patch rules.
	WindowsUpdate *WindowsUpdateSettings `json:"windowsUpdate,omitempty"`
	// Yum: Yum update settings. Use this setting to override the default `yum`
	// patch rules.
	Yum *YumSettings `json:"yum,omitempty"`
	// Zypper: Zypper update settings. Use this setting to override the default
	// `zypper` patch rules.
	Zypper *ZypperSettings `json:"zypper,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Apt") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Apt") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchConfig: Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.

func (PatchConfig) MarshalJSON

func (s PatchConfig) MarshalJSON() ([]byte, error)

type PatchDeployment

type PatchDeployment struct {
	// CreateTime: Output only. Time the patch deployment was created. Timestamp is
	// in RFC3339 (https://www.ietf.org/rfc/rfc3339.txt) text format.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Optional. Description of the patch deployment. Length of the
	// description is limited to 1024 characters.
	Description string `json:"description,omitempty"`
	// Duration: Optional. Duration of the patch. After the duration ends, the
	// patch times out.
	Duration string `json:"duration,omitempty"`
	// InstanceFilter: Required. VM instances to patch.
	InstanceFilter *PatchInstanceFilter `json:"instanceFilter,omitempty"`
	// LastExecuteTime: Output only. The last time a patch job was started by this
	// deployment. Timestamp is in RFC3339 (https://www.ietf.org/rfc/rfc3339.txt)
	// text format.
	LastExecuteTime string `json:"lastExecuteTime,omitempty"`
	// Name: Unique name for the patch deployment resource in a project. The patch
	// deployment name is in the form:
	// `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field
	// is ignored when you create a new patch deployment.
	Name string `json:"name,omitempty"`
	// OneTimeSchedule: Required. Schedule a one-time execution.
	OneTimeSchedule *OneTimeSchedule `json:"oneTimeSchedule,omitempty"`
	// PatchConfig: Optional. Patch configuration that is applied.
	PatchConfig *PatchConfig `json:"patchConfig,omitempty"`
	// RecurringSchedule: Required. Schedule recurring executions.
	RecurringSchedule *RecurringSchedule `json:"recurringSchedule,omitempty"`
	// Rollout: Optional. Rollout strategy of the patch job.
	Rollout *PatchRollout `json:"rollout,omitempty"`
	// State: Output only. Current state of the patch deployment.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The default value. This value is used if the state
	// is omitted.
	//   "ACTIVE" - Active value means that patch deployment generates Patch Jobs.
	//   "PAUSED" - Paused value means that patch deployment does not generate
	// Patch jobs. Requires user action to move in and out from this state.
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. Time the patch deployment was last updated.
	// Timestamp is in RFC3339 (https://www.ietf.org/rfc/rfc3339.txt) text format.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchDeployment: Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see Scheduling patch jobs (https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).

func (PatchDeployment) MarshalJSON

func (s PatchDeployment) MarshalJSON() ([]byte, error)

type PatchInstanceFilter

type PatchInstanceFilter struct {
	// All: Target all VM instances in the project. If true, no other criteria is
	// permitted.
	All bool `json:"all,omitempty"`
	// GroupLabels: Targets VM instances matching ANY of these GroupLabels. This
	// allows targeting of disparate groups of VM instances.
	GroupLabels []*PatchInstanceFilterGroupLabel `json:"groupLabels,omitempty"`
	// InstanceNamePrefixes: Targets VMs whose name starts with one of these
	// prefixes. Similar to labels, this is another way to group VMs when targeting
	// configs, for example prefix="prod-".
	InstanceNamePrefixes []string `json:"instanceNamePrefixes,omitempty"`
	// Instances: Targets any of the VM instances specified. Instances are
	// specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`,
	// `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or
	// `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/ins
	// tances/[INSTANCE_NAME]`
	Instances []string `json:"instances,omitempty"`
	// Zones: Targets VM instances in ANY of these zones. Leave empty to target VM
	// instances in any zone.
	Zones []string `json:"zones,omitempty"`
	// ForceSendFields is a list of field names (e.g. "All") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "All") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchInstanceFilter: A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.

func (PatchInstanceFilter) MarshalJSON

func (s PatchInstanceFilter) MarshalJSON() ([]byte, error)

type PatchInstanceFilterGroupLabel

type PatchInstanceFilterGroupLabel struct {
	// Labels: Compute Engine instance labels that must be present for a VM
	// instance to be targeted by this filter.
	Labels map[string]string `json:"labels,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchInstanceFilterGroupLabel: Targets a group of VM instances by using their assigned labels (https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.

func (PatchInstanceFilterGroupLabel) MarshalJSON

func (s PatchInstanceFilterGroupLabel) MarshalJSON() ([]byte, error)

type PatchJob

type PatchJob struct {
	// CreateTime: Time this patch job was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Description of the patch job. Length of the description is
	// limited to 1024 characters.
	Description string `json:"description,omitempty"`
	// DisplayName: Display name for this patch job. This is not a unique
	// identifier.
	DisplayName string `json:"displayName,omitempty"`
	// DryRun: If this patch job is a dry run, the agent reports that it has
	// finished without running any updates on the VM instance.
	DryRun bool `json:"dryRun,omitempty"`
	// Duration: Duration of the patch job. After the duration ends, the patch job
	// times out.
	Duration string `json:"duration,omitempty"`
	// ErrorMessage: If this patch job failed, this message provides information
	// about the failure.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// InstanceDetailsSummary: Summary of instance details.
	InstanceDetailsSummary *PatchJobInstanceDetailsSummary `json:"instanceDetailsSummary,omitempty"`
	// InstanceFilter: Instances to patch.
	InstanceFilter *PatchInstanceFilter `json:"instanceFilter,omitempty"`
	// Name: Unique identifier for this patch job in the form
	// `projects/*/patchJobs/*`
	Name string `json:"name,omitempty"`
	// PatchConfig: Patch configuration being applied.
	PatchConfig *PatchConfig `json:"patchConfig,omitempty"`
	// PatchDeployment: Output only. Name of the patch deployment that created this
	// patch job.
	PatchDeployment string `json:"patchDeployment,omitempty"`
	// PercentComplete: Reflects the overall progress of the patch job in the range
	// of 0.0 being no progress to 100.0 being complete.
	PercentComplete float64 `json:"percentComplete,omitempty"`
	// Rollout: Rollout strategy being applied.
	Rollout *PatchRollout `json:"rollout,omitempty"`
	// State: The current state of the PatchJob.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - State must be specified.
	//   "STARTED" - The patch job was successfully initiated.
	//   "INSTANCE_LOOKUP" - The patch job is looking up instances to run the patch
	// on.
	//   "PATCHING" - Instances are being patched.
	//   "SUCCEEDED" - Patch job completed successfully.
	//   "COMPLETED_WITH_ERRORS" - Patch job completed but there were errors.
	//   "CANCELED" - The patch job was canceled.
	//   "TIMED_OUT" - The patch job timed out.
	State string `json:"state,omitempty"`
	// UpdateTime: Last time this patch job was updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchJob: A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use `ListPatchJobInstanceDetails`. For more information about patch jobs, see Creating patch jobs (https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).

func (PatchJob) MarshalJSON

func (s PatchJob) MarshalJSON() ([]byte, error)

func (*PatchJob) UnmarshalJSON

func (s *PatchJob) UnmarshalJSON(data []byte) error

type PatchJobInstanceDetails

type PatchJobInstanceDetails struct {
	// AttemptCount: The number of times the agent that the agent attempts to apply
	// the patch.
	AttemptCount int64 `json:"attemptCount,omitempty,string"`
	// FailureReason: If the patch fails, this field provides the reason.
	FailureReason string `json:"failureReason,omitempty"`
	// InstanceSystemId: The unique identifier for the instance. This identifier is
	// defined by the server.
	InstanceSystemId string `json:"instanceSystemId,omitempty"`
	// Name: The instance name in the form `projects/*/zones/*/instances/*`
	Name string `json:"name,omitempty"`
	// State: Current state of instance patch.
	//
	// Possible values:
	//   "PATCH_STATE_UNSPECIFIED" - Unspecified.
	//   "PENDING" - The instance is not yet notified.
	//   "INACTIVE" - Instance is inactive and cannot be patched.
	//   "NOTIFIED" - The instance is notified that it should be patched.
	//   "STARTED" - The instance has started the patching process.
	//   "DOWNLOADING_PATCHES" - The instance is downloading patches.
	//   "APPLYING_PATCHES" - The instance is applying patches.
	//   "REBOOTING" - The instance is rebooting.
	//   "SUCCEEDED" - The instance has completed applying patches.
	//   "SUCCEEDED_REBOOT_REQUIRED" - The instance has completed applying patches
	// but a reboot is required.
	//   "FAILED" - The instance has failed to apply the patch.
	//   "ACKED" - The instance acked the notification and will start shortly.
	//   "TIMED_OUT" - The instance exceeded the time out while applying the patch.
	//   "RUNNING_PRE_PATCH_STEP" - The instance is running the pre-patch step.
	//   "RUNNING_POST_PATCH_STEP" - The instance is running the post-patch step.
	//   "NO_AGENT_DETECTED" - The service could not detect the presence of the
	// agent. Check to ensure that the agent is installed, running, and able to
	// communicate with the service.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttemptCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttemptCount") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchJobInstanceDetails: Patch details for a VM instance. For more information about reviewing VM instance details, see Listing all VM instance details for a specific patch job (https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).

func (PatchJobInstanceDetails) MarshalJSON

func (s PatchJobInstanceDetails) MarshalJSON() ([]byte, error)

type PatchJobInstanceDetailsSummary

type PatchJobInstanceDetailsSummary struct {
	// AckedInstanceCount: Number of instances that have acked and will start
	// shortly.
	AckedInstanceCount int64 `json:"ackedInstanceCount,omitempty,string"`
	// ApplyingPatchesInstanceCount: Number of instances that are applying patches.
	ApplyingPatchesInstanceCount int64 `json:"applyingPatchesInstanceCount,omitempty,string"`
	// DownloadingPatchesInstanceCount: Number of instances that are downloading
	// patches.
	DownloadingPatchesInstanceCount int64 `json:"downloadingPatchesInstanceCount,omitempty,string"`
	// FailedInstanceCount: Number of instances that failed.
	FailedInstanceCount int64 `json:"failedInstanceCount,omitempty,string"`
	// InactiveInstanceCount: Number of instances that are inactive.
	InactiveInstanceCount int64 `json:"inactiveInstanceCount,omitempty,string"`
	// NoAgentDetectedInstanceCount: Number of instances that do not appear to be
	// running the agent. Check to ensure that the agent is installed, running, and
	// able to communicate with the service.
	NoAgentDetectedInstanceCount int64 `json:"noAgentDetectedInstanceCount,omitempty,string"`
	// NotifiedInstanceCount: Number of instances notified about patch job.
	NotifiedInstanceCount int64 `json:"notifiedInstanceCount,omitempty,string"`
	// PendingInstanceCount: Number of instances pending patch job.
	PendingInstanceCount int64 `json:"pendingInstanceCount,omitempty,string"`
	// PostPatchStepInstanceCount: Number of instances that are running the
	// post-patch step.
	PostPatchStepInstanceCount int64 `json:"postPatchStepInstanceCount,omitempty,string"`
	// PrePatchStepInstanceCount: Number of instances that are running the
	// pre-patch step.
	PrePatchStepInstanceCount int64 `json:"prePatchStepInstanceCount,omitempty,string"`
	// RebootingInstanceCount: Number of instances rebooting.
	RebootingInstanceCount int64 `json:"rebootingInstanceCount,omitempty,string"`
	// StartedInstanceCount: Number of instances that have started.
	StartedInstanceCount int64 `json:"startedInstanceCount,omitempty,string"`
	// SucceededInstanceCount: Number of instances that have completed
	// successfully.
	SucceededInstanceCount int64 `json:"succeededInstanceCount,omitempty,string"`
	// SucceededRebootRequiredInstanceCount: Number of instances that require
	// reboot.
	SucceededRebootRequiredInstanceCount int64 `json:"succeededRebootRequiredInstanceCount,omitempty,string"`
	// TimedOutInstanceCount: Number of instances that exceeded the time out while
	// applying the patch.
	TimedOutInstanceCount int64 `json:"timedOutInstanceCount,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "AckedInstanceCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AckedInstanceCount") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchJobInstanceDetailsSummary: A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance.

func (PatchJobInstanceDetailsSummary) MarshalJSON

func (s PatchJobInstanceDetailsSummary) MarshalJSON() ([]byte, error)

type PatchRollout added in v0.30.0

type PatchRollout struct {
	// DisruptionBudget: The maximum number (or percentage) of VMs per zone to
	// disrupt at any given moment. The number of VMs calculated from multiplying
	// the percentage by the total number of VMs in a zone is rounded up. During
	// patching, a VM is considered disrupted from the time the agent is notified
	// to begin until patching has completed. This disruption time includes the
	// time to complete reboot and any post-patch steps. A VM contributes to the
	// disruption budget if its patching operation fails either when applying the
	// patches, running pre or post patch steps, or if it fails to respond with a
	// success notification before timing out. VMs that are not running or do not
	// have an active agent do not count toward this disruption budget. For
	// zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the
	// patch job stops, because continuing to the next zone requires completion of
	// the patch process in the previous zone. For example, if the disruption
	// budget has a fixed value of `10`, and 8 VMs fail to patch in the current
	// zone, the patch job continues to patch 2 VMs at a time until the zone is
	// completed. When that zone is completed successfully, patching begins with 10
	// VMs at a time in the next zone. If 10 VMs in the next zone fail to patch,
	// the patch job stops.
	DisruptionBudget *FixedOrPercent `json:"disruptionBudget,omitempty"`
	// Mode: Mode of the patch rollout.
	//
	// Possible values:
	//   "MODE_UNSPECIFIED" - Mode must be specified.
	//   "ZONE_BY_ZONE" - Patches are applied one zone at a time. The patch job
	// begins in the region with the lowest number of targeted VMs. Within the
	// region, patching begins in the zone with the lowest number of targeted VMs.
	// If multiple regions (or zones within a region) have the same number of
	// targeted VMs, a tie-breaker is achieved by sorting the regions or zones in
	// alphabetical order.
	//   "CONCURRENT_ZONES" - Patches are applied to VMs in all zones at the same
	// time.
	Mode string `json:"mode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisruptionBudget") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisruptionBudget") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PatchRollout: Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.

func (PatchRollout) MarshalJSON added in v0.30.0

func (s PatchRollout) MarshalJSON() ([]byte, error)

type PausePatchDeploymentRequest added in v0.63.0

type PausePatchDeploymentRequest struct {
}

PausePatchDeploymentRequest: A request message for pausing a patch deployment.

type ProjectFeatureSettings added in v0.171.0

type ProjectFeatureSettings struct {
	// Name: Required. Immutable. Name specifies the URL for the
	// ProjectFeatureSettings resource:
	// projects/project_id/locations/global/projectFeatureSettings.
	Name string `json:"name,omitempty"`
	// PatchAndConfigFeatureSet: Set PatchAndConfigFeatureSet for the project.
	//
	// Possible values:
	//   "PATCH_AND_CONFIG_FEATURE_SET_UNSPECIFIED" - Not specified placeholder
	//   "OSCONFIG_B" - Enables only the basic set of VM Manager features in the
	// project.
	//   "OSCONFIG_C" - Enables all VM Manager features in the project.
	PatchAndConfigFeatureSet string `json:"patchAndConfigFeatureSet,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ProjectFeatureSettings: ProjectFeatureSettings represents the VM Manager feature settings in a project. For more information, see Enable full VM Manager functionality.

func (ProjectFeatureSettings) MarshalJSON added in v0.171.0

func (s ProjectFeatureSettings) MarshalJSON() ([]byte, error)

type ProjectsLocationsGlobalGetProjectFeatureSettingsCall added in v0.171.0

type ProjectsLocationsGlobalGetProjectFeatureSettingsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGlobalGetProjectFeatureSettingsCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGlobalGetProjectFeatureSettingsCall) Do added in v0.171.0

Do executes the "osconfig.projects.locations.global.getProjectFeatureSettings" call. Any non-2xx status code is an error. Response headers are in either *ProjectFeatureSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGlobalGetProjectFeatureSettingsCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGlobalGetProjectFeatureSettingsCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGlobalGetProjectFeatureSettingsCall) IfNoneMatch added in v0.171.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsGlobalService added in v0.171.0

type ProjectsLocationsGlobalService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsGlobalService added in v0.171.0

func NewProjectsLocationsGlobalService(s *Service) *ProjectsLocationsGlobalService

func (*ProjectsLocationsGlobalService) GetProjectFeatureSettings added in v0.171.0

GetProjectFeatureSettings: GetProjectFeatureSettings returns the VM Manager feature settings for a project.

  • name: Name specifies the URL for the ProjectFeatureSettings resource: projects/project_id/locations/global/projectFeatureSettings.

func (*ProjectsLocationsGlobalService) UpdateProjectFeatureSettings added in v0.171.0

func (r *ProjectsLocationsGlobalService) UpdateProjectFeatureSettings(name string, projectfeaturesettings *ProjectFeatureSettings) *ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall

UpdateProjectFeatureSettings: UpdateProjectFeatureSettings sets the VM Manager features for a project.

  • name: Immutable. Name specifies the URL for the ProjectFeatureSettings resource: projects/project_id/locations/global/projectFeatureSettings.

type ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall added in v0.171.0

type ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall) Do added in v0.171.0

Do executes the "osconfig.projects.locations.global.updateProjectFeatureSettings" call. Any non-2xx status code is an error. Response headers are in either *ProjectFeatureSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGlobalUpdateProjectFeatureSettingsCall) UpdateMask added in v0.171.0

UpdateMask sets the optional parameter "updateMask": Field mask that controls which fields of the ProjectFeatureSettings should be updated.

type ProjectsLocationsInstancesInventoriesGetCall added in v0.53.0

type ProjectsLocationsInstancesInventoriesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesInventoriesGetCall) Context added in v0.53.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesInventoriesGetCall) Do added in v0.53.0

Do executes the "osconfig.projects.locations.instances.inventories.get" call. Any non-2xx status code is an error. Response headers are in either *Inventory.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesInventoriesGetCall) Fields added in v0.53.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesInventoriesGetCall) Header added in v0.53.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesInventoriesGetCall) IfNoneMatch added in v0.53.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesInventoriesGetCall) View added in v0.53.0

View sets the optional parameter "view": Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

Possible values:

"INVENTORY_VIEW_UNSPECIFIED" - The default value. The API defaults to the

BASIC view.

"BASIC" - Returns the basic inventory information that includes `os_info`.
"FULL" - Returns all fields.

type ProjectsLocationsInstancesInventoriesListCall added in v0.53.0

type ProjectsLocationsInstancesInventoriesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesInventoriesListCall) Context added in v0.53.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesInventoriesListCall) Do added in v0.53.0

Do executes the "osconfig.projects.locations.instances.inventories.list" call. Any non-2xx status code is an error. Response headers are in either *ListInventoriesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesInventoriesListCall) Fields added in v0.53.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesInventoriesListCall) Filter added in v0.53.0

Filter sets the optional parameter "filter": If provided, this field specifies the criteria that must be met by a `Inventory` API resource to be included in the response.

func (*ProjectsLocationsInstancesInventoriesListCall) Header added in v0.53.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesInventoriesListCall) IfNoneMatch added in v0.53.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesInventoriesListCall) PageSize added in v0.53.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return.

func (*ProjectsLocationsInstancesInventoriesListCall) PageToken added in v0.53.0

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListInventories` that indicates where this listing should continue from.

func (*ProjectsLocationsInstancesInventoriesListCall) Pages added in v0.53.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsInstancesInventoriesListCall) View added in v0.53.0

View sets the optional parameter "view": Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

Possible values:

"INVENTORY_VIEW_UNSPECIFIED" - The default value. The API defaults to the

BASIC view.

"BASIC" - Returns the basic inventory information that includes `os_info`.
"FULL" - Returns all fields.

type ProjectsLocationsInstancesInventoriesService added in v0.53.0

type ProjectsLocationsInstancesInventoriesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesInventoriesService added in v0.53.0

func NewProjectsLocationsInstancesInventoriesService(s *Service) *ProjectsLocationsInstancesInventoriesService

func (*ProjectsLocationsInstancesInventoriesService) Get added in v0.53.0

Get: Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned.

  • name: API resource name for inventory resource. Format: `projects/{project}/locations/{location}/instances/{instance}/inventory` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.

func (*ProjectsLocationsInstancesInventoriesService) List added in v0.53.0

List: List inventory data for all VM instances in the specified zone.

  • parent: The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.

type ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall added in v0.60.0

type ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall) Context added in v0.60.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall) Do added in v0.60.0

Do executes the "osconfig.projects.locations.instances.osPolicyAssignments.reports.get" call. Any non-2xx status code is an error. Response headers are in either *OSPolicyAssignmentReport.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall) Fields added in v0.60.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall) Header added in v0.60.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsGetCall) IfNoneMatch added in v0.60.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall added in v0.59.0

type ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) Context added in v0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) Do added in v0.59.0

Do executes the "osconfig.projects.locations.instances.osPolicyAssignments.reports.list" call. Any non-2xx status code is an error. Response headers are in either *ListOSPolicyAssignmentReportsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) Fields added in v0.59.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) Filter added in v0.59.0

Filter sets the optional parameter "filter": If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) Header added in v0.59.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) IfNoneMatch added in v0.59.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) PageSize added in v0.59.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) PageToken added in v0.59.0

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsListCall) Pages added in v0.59.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsInstancesOsPolicyAssignmentsReportsService added in v0.59.0

type ProjectsLocationsInstancesOsPolicyAssignmentsReportsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesOsPolicyAssignmentsReportsService added in v0.59.0

func NewProjectsLocationsInstancesOsPolicyAssignmentsReportsService(s *Service) *ProjectsLocationsInstancesOsPolicyAssignmentsReportsService

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsService) Get added in v0.60.0

Get: Get the OS policy assignment report for the specified Compute Engine VM instance.

  • name: API resource name for OS policy assignment report. Format: `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssi gnments/{assignment}/report` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance_id}`, either Compute Engine `instance-id` or `instance-name` can be provided. For `{assignment_id}`, the OSPolicyAssignment id must be provided.

func (*ProjectsLocationsInstancesOsPolicyAssignmentsReportsService) List added in v0.59.0

List: List OS policy assignment reports for all Compute Engine VM instances in the specified zone.

  • parent: The parent resource name. Format: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssig nments/{assignment}/reports` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either `instance-name`, `instance-id`, or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For `{assignment}`, either `assignment-id` or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be `-`. For example: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssig nments/-/reports` returns all reports for the instance `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{a ssignment-id}/reports` returns all the reports for the given assignment across all instances. `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/ reports` returns all the reports for all assignments across all instances.

type ProjectsLocationsInstancesOsPolicyAssignmentsService added in v0.59.0

type ProjectsLocationsInstancesOsPolicyAssignmentsService struct {
	Reports *ProjectsLocationsInstancesOsPolicyAssignmentsReportsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesOsPolicyAssignmentsService added in v0.59.0

func NewProjectsLocationsInstancesOsPolicyAssignmentsService(s *Service) *ProjectsLocationsInstancesOsPolicyAssignmentsService

type ProjectsLocationsInstancesService added in v0.53.0

type ProjectsLocationsInstancesService struct {
	Inventories *ProjectsLocationsInstancesInventoriesService

	OsPolicyAssignments *ProjectsLocationsInstancesOsPolicyAssignmentsService

	VulnerabilityReports *ProjectsLocationsInstancesVulnerabilityReportsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesService added in v0.53.0

func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService

type ProjectsLocationsInstancesVulnerabilityReportsGetCall added in v0.53.0

type ProjectsLocationsInstancesVulnerabilityReportsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesVulnerabilityReportsGetCall) Context added in v0.53.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesVulnerabilityReportsGetCall) Do added in v0.53.0

Do executes the "osconfig.projects.locations.instances.vulnerabilityReports.get" call. Any non-2xx status code is an error. Response headers are in either *VulnerabilityReport.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesVulnerabilityReportsGetCall) Fields added in v0.53.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesVulnerabilityReportsGetCall) Header added in v0.53.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesVulnerabilityReportsGetCall) IfNoneMatch added in v0.53.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInstancesVulnerabilityReportsListCall added in v0.53.0

type ProjectsLocationsInstancesVulnerabilityReportsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) Context added in v0.53.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) Do added in v0.53.0

Do executes the "osconfig.projects.locations.instances.vulnerabilityReports.list" call. Any non-2xx status code is an error. Response headers are in either *ListVulnerabilityReportsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) Fields added in v0.53.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) Filter added in v0.53.0

Filter sets the optional parameter "filter": This field supports filtering by the severity level for the vulnerability. For a list of severity levels, see Severity levels for vulnerabilities (https://cloud.google.com/container-analysis/docs/container-scanning-overview#severity_levels_for_vulnerabilities). The filter field follows the rules described in the AIP-160 (https://google.aip.dev/160) guidelines as follows: + **Filter for a specific severity type**: you can list reports that contain vulnerabilities that are classified as medium by specifying `vulnerabilities.details.severity:MEDIUM`. + **Filter for a range of severities** : you can list reports that have vulnerabilities that are classified as critical or high by specifying `vulnerabilities.details.severity:HIGH OR vulnerabilities.details.severity:CRITICAL`

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) Header added in v0.53.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) IfNoneMatch added in v0.53.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) PageSize added in v0.53.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) PageToken added in v0.53.0

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListVulnerabilityReports` that indicates where this listing should continue from.

func (*ProjectsLocationsInstancesVulnerabilityReportsListCall) Pages added in v0.53.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsInstancesVulnerabilityReportsService added in v0.53.0

type ProjectsLocationsInstancesVulnerabilityReportsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesVulnerabilityReportsService added in v0.53.0

func NewProjectsLocationsInstancesVulnerabilityReportsService(s *Service) *ProjectsLocationsInstancesVulnerabilityReportsService

func (*ProjectsLocationsInstancesVulnerabilityReportsService) Get added in v0.53.0

Get: Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

  • name: API resource name for vulnerability resource. Format: `projects/{project}/locations/{location}/instances/{instance}/vulnerability Report` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.

func (*ProjectsLocationsInstancesVulnerabilityReportsService) List added in v0.53.0

List: List vulnerability reports for all VM instances in the specified zone.

  • parent: The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.

type ProjectsLocationsOsPolicyAssignmentsCreateCall added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsCreateCall) Context added in v0.58.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsCreateCall) Do added in v0.58.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsCreateCall) Fields added in v0.58.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsCreateCall) Header added in v0.58.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsCreateCall) OsPolicyAssignmentId added in v0.58.0

OsPolicyAssignmentId sets the optional parameter "osPolicyAssignmentId": Required. The logical name of the OS policy assignment in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.

func (*ProjectsLocationsOsPolicyAssignmentsCreateCall) RequestId added in v0.181.0

RequestId sets the optional parameter "requestId": A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.

type ProjectsLocationsOsPolicyAssignmentsDeleteCall added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsDeleteCall) Context added in v0.58.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsDeleteCall) Do added in v0.58.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsDeleteCall) Fields added in v0.58.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsDeleteCall) Header added in v0.58.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsDeleteCall) RequestId added in v0.181.0

RequestId sets the optional parameter "requestId": A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.

type ProjectsLocationsOsPolicyAssignmentsGetCall added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsGetCall) Context added in v0.58.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsGetCall) Do added in v0.58.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.get" call. Any non-2xx status code is an error. Response headers are in either *OSPolicyAssignment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsGetCall) Fields added in v0.58.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsGetCall) Header added in v0.58.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsGetCall) IfNoneMatch added in v0.58.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOsPolicyAssignmentsListCall added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsListCall) Context added in v0.58.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) Do added in v0.58.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.list" call. Any non-2xx status code is an error. Response headers are in either *ListOSPolicyAssignmentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) Fields added in v0.58.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) Header added in v0.58.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) IfNoneMatch added in v0.58.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) PageSize added in v0.58.0

PageSize sets the optional parameter "pageSize": The maximum number of assignments to return.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) PageToken added in v0.58.0

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from.

func (*ProjectsLocationsOsPolicyAssignmentsListCall) Pages added in v0.58.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOsPolicyAssignmentsListRevisionsCall added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsListRevisionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) Context added in v0.58.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) Do added in v0.58.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.listRevisions" call. Any non-2xx status code is an error. Response headers are in either *ListOSPolicyAssignmentRevisionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) Fields added in v0.58.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) Header added in v0.58.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) IfNoneMatch added in v0.58.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) PageSize added in v0.58.0

PageSize sets the optional parameter "pageSize": The maximum number of revisions to return.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) PageToken added in v0.58.0

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from.

func (*ProjectsLocationsOsPolicyAssignmentsListRevisionsCall) Pages added in v0.58.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOsPolicyAssignmentsOperationsCancelCall added in v0.59.0

type ProjectsLocationsOsPolicyAssignmentsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsOperationsCancelCall) Context added in v0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsCancelCall) Do added in v0.59.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsCancelCall) Fields added in v0.59.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsCancelCall) Header added in v0.59.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOsPolicyAssignmentsOperationsGetCall added in v0.59.0

type ProjectsLocationsOsPolicyAssignmentsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsOperationsGetCall) Context added in v0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsGetCall) Do added in v0.59.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsGetCall) Fields added in v0.59.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsGetCall) Header added in v0.59.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsGetCall) IfNoneMatch added in v0.59.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOsPolicyAssignmentsOperationsService added in v0.59.0

type ProjectsLocationsOsPolicyAssignmentsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOsPolicyAssignmentsOperationsService added in v0.59.0

func NewProjectsLocationsOsPolicyAssignmentsOperationsService(s *Service) *ProjectsLocationsOsPolicyAssignmentsOperationsService

func (*ProjectsLocationsOsPolicyAssignmentsOperationsService) Cancel added in v0.59.0

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOsPolicyAssignmentsOperationsService) Get added in v0.59.0

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

type ProjectsLocationsOsPolicyAssignmentsPatchCall added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) AllowMissing added in v0.181.0

AllowMissing sets the optional parameter "allowMissing": If set to true, and the OS policy assignment is not found, a new OS policy assignment will be created. In this situation, `update_mask` is ignored.

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) Context added in v0.58.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) Do added in v0.58.0

Do executes the "osconfig.projects.locations.osPolicyAssignments.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) Fields added in v0.58.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) Header added in v0.58.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) RequestId added in v0.181.0

RequestId sets the optional parameter "requestId": A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.

func (*ProjectsLocationsOsPolicyAssignmentsPatchCall) UpdateMask added in v0.58.0

UpdateMask sets the optional parameter "updateMask": Field mask that controls which fields of the assignment should be updated.

type ProjectsLocationsOsPolicyAssignmentsService added in v0.58.0

type ProjectsLocationsOsPolicyAssignmentsService struct {
	Operations *ProjectsLocationsOsPolicyAssignmentsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsOsPolicyAssignmentsService added in v0.58.0

func NewProjectsLocationsOsPolicyAssignmentsService(s *Service) *ProjectsLocationsOsPolicyAssignmentsService

func (*ProjectsLocationsOsPolicyAssignmentsService) Create added in v0.58.0

Create: Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel (https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).

  • parent: The parent resource name in the form: projects/{project}/locations/{location}. Note: Specify the zone of your VMs as the location.

func (*ProjectsLocationsOsPolicyAssignmentsService) Delete added in v0.58.0

Delete: Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel (https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).

- name: The name of the OS policy assignment to be deleted.

func (*ProjectsLocationsOsPolicyAssignmentsService) Get added in v0.58.0

Get: Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter.

  • name: The resource name of OS policy assignment. Format: `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_ass ignment}@{revisionId}`.

func (*ProjectsLocationsOsPolicyAssignmentsService) List added in v0.58.0

List: List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

- parent: The parent resource name.

func (*ProjectsLocationsOsPolicyAssignmentsService) ListRevisions added in v0.58.0

ListRevisions: List the OS policy assignment revisions for a given OS policy assignment.

- name: The name of the OS policy assignment to list revisions for.

func (*ProjectsLocationsOsPolicyAssignmentsService) Patch added in v0.58.0

Patch: Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel (https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).

  • name: Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_pol icy_assignment_id}` This field is ignored when you create an OS policy assignment.

type ProjectsLocationsService added in v0.53.0

type ProjectsLocationsService struct {
	Global *ProjectsLocationsGlobalService

	Instances *ProjectsLocationsInstancesService

	OsPolicyAssignments *ProjectsLocationsOsPolicyAssignmentsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService added in v0.53.0

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsPatchDeploymentsCreateCall

type ProjectsPatchDeploymentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsCreateCall) Do

Do executes the "osconfig.projects.patchDeployments.create" call. Any non-2xx status code is an error. Response headers are in either *PatchDeployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchDeploymentsCreateCall) PatchDeploymentId

func (c *ProjectsPatchDeploymentsCreateCall) PatchDeploymentId(patchDeploymentId string) *ProjectsPatchDeploymentsCreateCall

PatchDeploymentId sets the optional parameter "patchDeploymentId": Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.

type ProjectsPatchDeploymentsDeleteCall

type ProjectsPatchDeploymentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsDeleteCall) Do

Do executes the "osconfig.projects.patchDeployments.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsPatchDeploymentsGetCall

type ProjectsPatchDeploymentsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsGetCall) Do

Do executes the "osconfig.projects.patchDeployments.get" call. Any non-2xx status code is an error. Response headers are in either *PatchDeployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchDeploymentsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsPatchDeploymentsListCall

type ProjectsPatchDeploymentsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsListCall) Do

Do executes the "osconfig.projects.patchDeployments.list" call. Any non-2xx status code is an error. Response headers are in either *ListPatchDeploymentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchDeploymentsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsPatchDeploymentsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of patch deployments to return. Default is 100.

func (*ProjectsPatchDeploymentsListCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.

func (*ProjectsPatchDeploymentsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsPatchDeploymentsPatchCall added in v0.59.0

type ProjectsPatchDeploymentsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsPatchCall) Context added in v0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsPatchCall) Do added in v0.59.0

Do executes the "osconfig.projects.patchDeployments.patch" call. Any non-2xx status code is an error. Response headers are in either *PatchDeployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsPatchCall) Fields added in v0.59.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsPatchCall) Header added in v0.59.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchDeploymentsPatchCall) UpdateMask added in v0.59.0

UpdateMask sets the optional parameter "updateMask": Field mask that controls which fields of the patch deployment should be updated.

type ProjectsPatchDeploymentsPauseCall added in v0.63.0

type ProjectsPatchDeploymentsPauseCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsPauseCall) Context added in v0.63.0

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsPauseCall) Do added in v0.63.0

Do executes the "osconfig.projects.patchDeployments.pause" call. Any non-2xx status code is an error. Response headers are in either *PatchDeployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsPauseCall) Fields added in v0.63.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsPauseCall) Header added in v0.63.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsPatchDeploymentsResumeCall added in v0.63.0

type ProjectsPatchDeploymentsResumeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchDeploymentsResumeCall) Context added in v0.63.0

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchDeploymentsResumeCall) Do added in v0.63.0

Do executes the "osconfig.projects.patchDeployments.resume" call. Any non-2xx status code is an error. Response headers are in either *PatchDeployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchDeploymentsResumeCall) Fields added in v0.63.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchDeploymentsResumeCall) Header added in v0.63.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsPatchDeploymentsService

type ProjectsPatchDeploymentsService struct {
	// contains filtered or unexported fields
}

func NewProjectsPatchDeploymentsService

func NewProjectsPatchDeploymentsService(s *Service) *ProjectsPatchDeploymentsService

func (*ProjectsPatchDeploymentsService) Create

Create: Create an OS Config patch deployment.

  • parent: The project to apply this patch deployment to in the form `projects/*`.

func (*ProjectsPatchDeploymentsService) Delete

Delete: Delete an OS Config patch deployment.

  • name: The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.

func (*ProjectsPatchDeploymentsService) Get

Get: Get an OS Config patch deployment.

  • name: The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.

func (*ProjectsPatchDeploymentsService) List

List: Get a page of OS Config patch deployments.

- parent: The resource name of the parent in the form `projects/*`.

func (*ProjectsPatchDeploymentsService) Patch added in v0.59.0

Patch: Update an OS Config patch deployment.

  • name: Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.

func (*ProjectsPatchDeploymentsService) Pause added in v0.63.0

Pause: Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

  • name: The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.

func (*ProjectsPatchDeploymentsService) Resume added in v0.63.0

Resume: Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

  • name: The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.

type ProjectsPatchJobsCancelCall

type ProjectsPatchJobsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchJobsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchJobsCancelCall) Do

Do executes the "osconfig.projects.patchJobs.cancel" call. Any non-2xx status code is an error. Response headers are in either *PatchJob.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchJobsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchJobsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsPatchJobsExecuteCall

type ProjectsPatchJobsExecuteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchJobsExecuteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchJobsExecuteCall) Do

Do executes the "osconfig.projects.patchJobs.execute" call. Any non-2xx status code is an error. Response headers are in either *PatchJob.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchJobsExecuteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchJobsExecuteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsPatchJobsGetCall

type ProjectsPatchJobsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchJobsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchJobsGetCall) Do

Do executes the "osconfig.projects.patchJobs.get" call. Any non-2xx status code is an error. Response headers are in either *PatchJob.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchJobsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchJobsGetCall) Header

func (c *ProjectsPatchJobsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchJobsGetCall) IfNoneMatch

func (c *ProjectsPatchJobsGetCall) IfNoneMatch(entityTag string) *ProjectsPatchJobsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsPatchJobsInstanceDetailsListCall

type ProjectsPatchJobsInstanceDetailsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchJobsInstanceDetailsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchJobsInstanceDetailsListCall) Do

Do executes the "osconfig.projects.patchJobs.instanceDetails.list" call. Any non-2xx status code is an error. Response headers are in either *ListPatchJobInstanceDetailsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchJobsInstanceDetailsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchJobsInstanceDetailsListCall) Filter

Filter sets the optional parameter "filter": A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.

func (*ProjectsPatchJobsInstanceDetailsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchJobsInstanceDetailsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsPatchJobsInstanceDetailsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of instance details records to return. Default is 100.

func (*ProjectsPatchJobsInstanceDetailsListCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call that indicates where this listing should continue from.

func (*ProjectsPatchJobsInstanceDetailsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsPatchJobsInstanceDetailsService

type ProjectsPatchJobsInstanceDetailsService struct {
	// contains filtered or unexported fields
}

func NewProjectsPatchJobsInstanceDetailsService

func NewProjectsPatchJobsInstanceDetailsService(s *Service) *ProjectsPatchJobsInstanceDetailsService

func (*ProjectsPatchJobsInstanceDetailsService) List

List: Get a list of instance details for a given patch job.

  • parent: The parent for the instances are in the form of `projects/*/patchJobs/*`.

type ProjectsPatchJobsListCall

type ProjectsPatchJobsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsPatchJobsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsPatchJobsListCall) Do

Do executes the "osconfig.projects.patchJobs.list" call. Any non-2xx status code is an error. Response headers are in either *ListPatchJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchJobsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsPatchJobsListCall) Filter

Filter sets the optional parameter "filter": If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.

func (*ProjectsPatchJobsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsPatchJobsListCall) IfNoneMatch

func (c *ProjectsPatchJobsListCall) IfNoneMatch(entityTag string) *ProjectsPatchJobsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsPatchJobsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of instance status to return.

func (*ProjectsPatchJobsListCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call that indicates where this listing should continue from.

func (*ProjectsPatchJobsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsPatchJobsService

type ProjectsPatchJobsService struct {
	InstanceDetails *ProjectsPatchJobsInstanceDetailsService
	// contains filtered or unexported fields
}

func NewProjectsPatchJobsService

func NewProjectsPatchJobsService(s *Service) *ProjectsPatchJobsService

func (*ProjectsPatchJobsService) Cancel

func (r *ProjectsPatchJobsService) Cancel(name string, cancelpatchjobrequest *CancelPatchJobRequest) *ProjectsPatchJobsCancelCall

Cancel: Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

- name: Name of the patch in the form `projects/*/patchJobs/*`.

func (*ProjectsPatchJobsService) Execute

func (r *ProjectsPatchJobsService) Execute(parent string, executepatchjobrequest *ExecutePatchJobRequest) *ProjectsPatchJobsExecuteCall

Execute: Patch VM instances by creating and running a patch job.

- parent: The project in which to run this patch in the form `projects/*`.

func (*ProjectsPatchJobsService) Get

Get: Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

- name: Name of the patch in the form `projects/*/patchJobs/*`.

func (*ProjectsPatchJobsService) List

List: Get a list of patch jobs.

- parent: In the form of `projects/*`.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService

	PatchDeployments *ProjectsPatchDeploymentsService

	PatchJobs *ProjectsPatchJobsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type RecurringSchedule

type RecurringSchedule struct {
	// EndTime: Optional. The end time at which a recurring patch deployment
	// schedule is no longer active.
	EndTime string `json:"endTime,omitempty"`
	// Frequency: Required. The frequency unit of this recurring schedule.
	//
	// Possible values:
	//   "FREQUENCY_UNSPECIFIED" - Invalid. A frequency must be specified.
	//   "WEEKLY" - Indicates that the frequency of recurrence should be expressed
	// in terms of weeks.
	//   "MONTHLY" - Indicates that the frequency of recurrence should be expressed
	// in terms of months.
	//   "DAILY" - Indicates that the frequency of recurrence should be expressed
	// in terms of days.
	Frequency string `json:"frequency,omitempty"`
	// LastExecuteTime: Output only. The time the last patch job ran successfully.
	LastExecuteTime string `json:"lastExecuteTime,omitempty"`
	// Monthly: Required. Schedule with monthly executions.
	Monthly *MonthlySchedule `json:"monthly,omitempty"`
	// NextExecuteTime: Output only. The time the next patch job is scheduled to
	// run.
	NextExecuteTime string `json:"nextExecuteTime,omitempty"`
	// StartTime: Optional. The time that the recurring schedule becomes effective.
	// Defaults to `create_time` of the patch deployment.
	StartTime string `json:"startTime,omitempty"`
	// TimeOfDay: Required. Time of the day to run a recurring deployment.
	TimeOfDay *TimeOfDay `json:"timeOfDay,omitempty"`
	// TimeZone: Required. Defines the time zone that `time_of_day` is relative to.
	// The rules for daylight saving time are determined by the chosen time zone.
	TimeZone *TimeZone `json:"timeZone,omitempty"`
	// Weekly: Required. Schedule with weekly executions.
	Weekly *WeeklySchedule `json:"weekly,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RecurringSchedule: Sets the time for recurring patch deployments.

func (RecurringSchedule) MarshalJSON

func (s RecurringSchedule) MarshalJSON() ([]byte, error)

type ResumePatchDeploymentRequest added in v0.63.0

type ResumePatchDeploymentRequest struct {
}

ResumePatchDeploymentRequest: A request message for resuming a patch deployment.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status added in v0.43.0

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON added in v0.43.0

func (s Status) MarshalJSON() ([]byte, error)

type TimeOfDay

type TimeOfDay struct {
	// Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0
	// and typically must be less than or equal to 23. An API may choose to allow
	// the value "24:00:00" for scenarios like business closing time.
	Hours int64 `json:"hours,omitempty"`
	// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less
	// than or equal to 59.
	Minutes int64 `json:"minutes,omitempty"`
	// Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal
	// to 0 and less than or equal to 999,999,999.
	Nanos int64 `json:"nanos,omitempty"`
	// Seconds: Seconds of a minute. Must be greater than or equal to 0 and
	// typically must be less than or equal to 59. An API may allow the value 60 if
	// it allows leap-seconds.
	Seconds int64 `json:"seconds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Hours") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Hours") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TimeOfDay: Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

func (TimeOfDay) MarshalJSON

func (s TimeOfDay) MarshalJSON() ([]byte, error)

type TimeZone

type TimeZone struct {
	// Id: IANA Time Zone Database time zone. For example "America/New_York".
	Id string `json:"id,omitempty"`
	// Version: Optional. IANA Time Zone Database version number. For example
	// "2019a".
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Id") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TimeZone: Represents a time zone from the IANA Time Zone Database (https://www.iana.org/time-zones).

func (TimeZone) MarshalJSON

func (s TimeZone) MarshalJSON() ([]byte, error)

type VulnerabilityReport added in v0.53.0

type VulnerabilityReport struct {
	// Name: Output only. The `vulnerabilityReport` API resource name. Format:
	// `projects/{project_number}/locations/{location}/instances/{instance_id}/vulne
	// rabilityReport`
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. The timestamp for when the last vulnerability
	// report was generated for the VM.
	UpdateTime string `json:"updateTime,omitempty"`
	// Vulnerabilities: Output only. List of vulnerabilities affecting the VM.
	Vulnerabilities []*VulnerabilityReportVulnerability `json:"vulnerabilities,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

VulnerabilityReport: This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see Vulnerability reports (https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).

func (VulnerabilityReport) MarshalJSON added in v0.53.0

func (s VulnerabilityReport) MarshalJSON() ([]byte, error)

type VulnerabilityReportVulnerability added in v0.53.0

type VulnerabilityReportVulnerability struct {
	// AvailableInventoryItemIds: Corresponds to the `AVAILABLE_PACKAGE` inventory
	// item on the VM. If the vulnerability report was not updated after the VM
	// inventory update, these values might not display in VM inventory. If there
	// is no available fix, the field is empty. The `inventory_item` value
	// specifies the latest `SoftwarePackage` available to the VM that fixes the
	// vulnerability.
	AvailableInventoryItemIds []string `json:"availableInventoryItemIds,omitempty"`
	// CreateTime: The timestamp for when the vulnerability was first detected.
	CreateTime string `json:"createTime,omitempty"`
	// Details: Contains metadata as per the upstream feed of the operating system
	// and NVD.
	Details *VulnerabilityReportVulnerabilityDetails `json:"details,omitempty"`
	// InstalledInventoryItemIds: Corresponds to the `INSTALLED_PACKAGE` inventory
	// item on the VM. This field displays the inventory items affected by this
	// vulnerability. If the vulnerability report was not updated after the VM
	// inventory update, these values might not display in VM inventory. For some
	// distros, this field may be empty.
	InstalledInventoryItemIds []string `json:"installedInventoryItemIds,omitempty"`
	// Items: List of items affected by the vulnerability.
	Items []*VulnerabilityReportVulnerabilityItem `json:"items,omitempty"`
	// UpdateTime: The timestamp for when the vulnerability was last modified.
	UpdateTime string `json:"updateTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AvailableInventoryItemIds")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AvailableInventoryItemIds") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

VulnerabilityReportVulnerability: A vulnerability affecting the VM instance.

func (VulnerabilityReportVulnerability) MarshalJSON added in v0.53.0

func (s VulnerabilityReportVulnerability) MarshalJSON() ([]byte, error)

type VulnerabilityReportVulnerabilityDetails added in v0.53.0

type VulnerabilityReportVulnerabilityDetails struct {
	// Cve: The CVE of the vulnerability. CVE cannot be empty and the combination
	// of should be unique across vulnerabilities for a VM.
	Cve string `json:"cve,omitempty"`
	// CvssV2Score: The CVSS V2 score of this vulnerability. CVSS V2 score is on a
	// scale of 0 - 10 where 0 indicates low severity and 10 indicates high
	// severity.
	CvssV2Score float64 `json:"cvssV2Score,omitempty"`
	// CvssV3: The full description of the CVSSv3 for this vulnerability from NVD.
	CvssV3 *CVSSv3 `json:"cvssV3,omitempty"`
	// Description: The note or description describing the vulnerability from the
	// distro.
	Description string `json:"description,omitempty"`
	// References: Corresponds to the references attached to the
	// `VulnerabilityDetails`.
	References []*VulnerabilityReportVulnerabilityDetailsReference `json:"references,omitempty"`
	// Severity: Assigned severity/impact ranking from the distro.
	Severity string `json:"severity,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cve") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cve") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

VulnerabilityReportVulnerabilityDetails: Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.

func (VulnerabilityReportVulnerabilityDetails) MarshalJSON added in v0.53.0

func (s VulnerabilityReportVulnerabilityDetails) MarshalJSON() ([]byte, error)

func (*VulnerabilityReportVulnerabilityDetails) UnmarshalJSON added in v0.53.0

func (s *VulnerabilityReportVulnerabilityDetails) UnmarshalJSON(data []byte) error

type VulnerabilityReportVulnerabilityDetailsReference added in v0.53.0

type VulnerabilityReportVulnerabilityDetailsReference struct {
	// Source: The source of the reference e.g. NVD.
	Source string `json:"source,omitempty"`
	// Url: The url of the reference.
	Url string `json:"url,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Source") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Source") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

VulnerabilityReportVulnerabilityDetailsReference: A reference for this vulnerability.

func (VulnerabilityReportVulnerabilityDetailsReference) MarshalJSON added in v0.53.0

type VulnerabilityReportVulnerabilityItem added in v0.61.0

type VulnerabilityReportVulnerabilityItem struct {
	// AvailableInventoryItemId: Corresponds to the `AVAILABLE_PACKAGE` inventory
	// item on the VM. If the vulnerability report was not updated after the VM
	// inventory update, these values might not display in VM inventory. If there
	// is no available fix, the field is empty. The `inventory_item` value
	// specifies the latest `SoftwarePackage` available to the VM that fixes the
	// vulnerability.
	AvailableInventoryItemId string `json:"availableInventoryItemId,omitempty"`
	// FixedCpeUri: The recommended CPE URI (https://cpe.mitre.org/specification/)
	// update that contains a fix for this vulnerability.
	FixedCpeUri string `json:"fixedCpeUri,omitempty"`
	// InstalledInventoryItemId: Corresponds to the `INSTALLED_PACKAGE` inventory
	// item on the VM. This field displays the inventory items affected by this
	// vulnerability. If the vulnerability report was not updated after the VM
	// inventory update, these values might not display in VM inventory. For some
	// operating systems, this field might be empty.
	InstalledInventoryItemId string `json:"installedInventoryItemId,omitempty"`
	// UpstreamFix: The upstream OS patch, packages or KB that fixes the
	// vulnerability.
	UpstreamFix string `json:"upstreamFix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AvailableInventoryItemId")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AvailableInventoryItemId") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

VulnerabilityReportVulnerabilityItem: OS inventory item that is affected by a vulnerability or fixed as a result of a vulnerability.

func (VulnerabilityReportVulnerabilityItem) MarshalJSON added in v0.61.0

func (s VulnerabilityReportVulnerabilityItem) MarshalJSON() ([]byte, error)

type WeekDayOfMonth

type WeekDayOfMonth struct {
	// DayOfWeek: Required. A day of the week.
	//
	// Possible values:
	//   "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.
	//   "MONDAY" - Monday
	//   "TUESDAY" - Tuesday
	//   "WEDNESDAY" - Wednesday
	//   "THURSDAY" - Thursday
	//   "FRIDAY" - Friday
	//   "SATURDAY" - Saturday
	//   "SUNDAY" - Sunday
	DayOfWeek string `json:"dayOfWeek,omitempty"`
	// DayOffset: Optional. Represents the number of days before or after the given
	// week day of month that the patch deployment is scheduled for. For example if
	// `week_ordinal` and `day_of_week` values point to the second Tuesday of the
	// month and the `day_offset` value is set to `3`, patch deployment takes place
	// three days after the second Tuesday of the month. If this value is negative,
	// for example -5, patches are deployed five days before the second Tuesday of
	// the month. Allowed values are in range [-30, 30].
	DayOffset int64 `json:"dayOffset,omitempty"`
	// WeekOrdinal: Required. Week number in a month. 1-4 indicates the 1st to 4th
	// week of the month. -1 indicates the last week of the month.
	WeekOrdinal int64 `json:"weekOrdinal,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DayOfWeek") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DayOfWeek") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WeekDayOfMonth: Represents one week day in a month. An example is "the 4th Sunday".

func (WeekDayOfMonth) MarshalJSON

func (s WeekDayOfMonth) MarshalJSON() ([]byte, error)

type WeeklySchedule

type WeeklySchedule struct {
	// DayOfWeek: Required. Day of the week.
	//
	// Possible values:
	//   "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.
	//   "MONDAY" - Monday
	//   "TUESDAY" - Tuesday
	//   "WEDNESDAY" - Wednesday
	//   "THURSDAY" - Thursday
	//   "FRIDAY" - Friday
	//   "SATURDAY" - Saturday
	//   "SUNDAY" - Sunday
	DayOfWeek string `json:"dayOfWeek,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DayOfWeek") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DayOfWeek") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WeeklySchedule: Represents a weekly schedule.

func (WeeklySchedule) MarshalJSON

func (s WeeklySchedule) MarshalJSON() ([]byte, error)

type WindowsUpdateSettings

type WindowsUpdateSettings struct {
	// Classifications: Only apply updates of these windows update classifications.
	// If empty, all updates are applied.
	//
	// Possible values:
	//   "CLASSIFICATION_UNSPECIFIED" - Invalid. If classifications are included,
	// they must be specified.
	//   "CRITICAL" - "A widely released fix for a specific problem that addresses
	// a critical, non-security-related bug." [1]
	//   "SECURITY" - "A widely released fix for a product-specific,
	// security-related vulnerability. Security vulnerabilities are rated by their
	// severity. The severity rating is indicated in the Microsoft security
	// bulletin as critical, important, moderate, or low." [1]
	//   "DEFINITION" - "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, phishing websites, or junk mail." [1]
	//   "DRIVER" - "Software that controls the input and output of a device." [1]
	//   "FEATURE_PACK" - "New product functionality that is first distributed
	// outside the context of a product release and that is typically included in
	// the next full product release." [1]
	//   "SERVICE_PACK" - "A tested, cumulative set of all hotfixes, security
	// updates, critical updates, and updates. Additionally, service packs may
	// contain additional fixes for problems that are found internally since the
	// release of the product. Service packs my also contain a limited number of
	// customer-requested design changes or features." [1]
	//   "TOOL" - "A utility or feature that helps complete a task or set of
	// tasks." [1]
	//   "UPDATE_ROLLUP" - "A tested, cumulative set of hotfixes, security updates,
	// critical updates, and updates that are packaged together for easy
	// deployment. A rollup generally targets a specific area, such as security, or
	// a component of a product, such as Internet Information Services (IIS)." [1]
	//   "UPDATE" - "A widely released fix for a specific problem. An update
	// addresses a noncritical, non-security-related bug." [1]
	Classifications []string `json:"classifications,omitempty"`
	// Excludes: List of KBs to exclude from update.
	Excludes []string `json:"excludes,omitempty"`
	// ExclusivePatches: An exclusive list of kbs to be updated. These are the only
	// patches that will be updated. This field must not be used with other patch
	// configurations.
	ExclusivePatches []string `json:"exclusivePatches,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Classifications") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Classifications") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WindowsUpdateSettings: Windows patching is performed using the Windows Update Agent.

func (WindowsUpdateSettings) MarshalJSON

func (s WindowsUpdateSettings) MarshalJSON() ([]byte, error)

type YumSettings

type YumSettings struct {
	// Excludes: List of packages to exclude from update. These packages are
	// excluded by using the yum `--exclude` flag.
	Excludes []string `json:"excludes,omitempty"`
	// ExclusivePackages: An exclusive list of packages to be updated. These are
	// the only packages that will be updated. If these packages are not installed,
	// they will be ignored. This field must not be specified with any other patch
	// configuration fields.
	ExclusivePackages []string `json:"exclusivePackages,omitempty"`
	// Minimal: Will cause patch to run `yum update-minimal` instead.
	Minimal bool `json:"minimal,omitempty"`
	// Security: Adds the `--security` flag to `yum update`. Not supported on all
	// platforms.
	Security bool `json:"security,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Excludes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Excludes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

YumSettings: Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms.

func (YumSettings) MarshalJSON

func (s YumSettings) MarshalJSON() ([]byte, error)

type ZypperSettings

type ZypperSettings struct {
	// Categories: Install only patches with these categories. Common categories
	// include security, recommended, and feature.
	Categories []string `json:"categories,omitempty"`
	// Excludes: List of patches to exclude from update.
	Excludes []string `json:"excludes,omitempty"`
	// ExclusivePatches: An exclusive list of patches to be updated. These are the
	// only patches that will be installed using 'zypper patch patch:' command.
	// This field must not be used with any other patch configuration fields.
	ExclusivePatches []string `json:"exclusivePatches,omitempty"`
	// Severities: Install only patches with these severities. Common severities
	// include critical, important, moderate, and low.
	Severities []string `json:"severities,omitempty"`
	// WithOptional: Adds the `--with-optional` flag to `zypper patch`.
	WithOptional bool `json:"withOptional,omitempty"`
	// WithUpdate: Adds the `--with-update` flag, to `zypper patch`.
	WithUpdate bool `json:"withUpdate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Categories") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Categories") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ZypperSettings: Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual.

func (ZypperSettings) MarshalJSON

func (s ZypperSettings) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL