osconfig

package
v0.181.0 Latest Latest
Warning

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

Go to latest
Published: May 16, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

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/v1beta"
...
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 AptRepository

type AptRepository struct {
	// ArchiveType: Type of archive files in this repository. The default behavior
	// is DEB.
	//
	// Possible values:
	//   "ARCHIVE_TYPE_UNSPECIFIED" - Unspecified.
	//   "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` containing
	// all the keys in any applied guest policy.
	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:"-"`
}

AptRepository: Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`.

func (*AptRepository) MarshalJSON

func (s *AptRepository) MarshalJSON() ([]byte, error)

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 Assignment

type Assignment struct {
	// GroupLabels: Targets instances matching at least one of these label sets.
	// This allows an assignment to target disparate groups, for example "env=prod
	// or env=staging".
	GroupLabels []*AssignmentGroupLabel `json:"groupLabels,omitempty"`
	// InstanceNamePrefixes: Targets VM instances whose name starts with one of
	// these prefixes. Like labels, this is another way to group VM instances when
	// targeting configs, for example prefix="prod-". Only supported for
	// project-level policies.
	InstanceNamePrefixes []string `json:"instanceNamePrefixes,omitempty"`
	// Instances: Targets any of the instances specified. Instances are specified
	// by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance
	// targeting is uncommon and is supported to facilitate the management of
	// changes by the instance or to target specific VM instances for development
	// and testing. Only supported for project-level policies and must reference
	// instances within this project.
	Instances []string `json:"instances,omitempty"`
	// OsTypes: Targets VM instances matching at least one of the following OS
	// types. VM instances must match all supplied criteria for a given OsType to
	// be included.
	OsTypes []*AssignmentOsType `json:"osTypes,omitempty"`
	// Zones: Targets instances in any of these zones. Leave empty to target
	// instances in any zone. Zonal targeting is uncommon and is supported to
	// facilitate the management of changes by zone.
	Zones []string `json:"zones,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GroupLabels") 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. "GroupLabels") 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:"-"`
}

Assignment: An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.

func (*Assignment) MarshalJSON

func (s *Assignment) MarshalJSON() ([]byte, error)

type AssignmentGroupLabel

type AssignmentGroupLabel struct {
	// Labels: Google Compute Engine instance labels that must be present for an
	// instance to be included in this assignment group.
	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:"-"`
}

AssignmentGroupLabel: Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".

func (*AssignmentGroupLabel) MarshalJSON

func (s *AssignmentGroupLabel) MarshalJSON() ([]byte, error)

type AssignmentOsType

type AssignmentOsType struct {
	// OsArchitecture: Targets VM instances with OS Inventory enabled and having
	// the following OS architecture.
	OsArchitecture string `json:"osArchitecture,omitempty"`
	// OsShortName: Targets VM instances with OS Inventory enabled and having the
	// following OS short name, for example "debian" or "windows".
	OsShortName string `json:"osShortName,omitempty"`
	// OsVersion: Targets VM instances with OS Inventory enabled and having the
	// following following OS version.
	OsVersion string `json:"osVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OsArchitecture") 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. "OsArchitecture") 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:"-"`
}

AssignmentOsType: Defines the criteria for selecting VM Instances by OS type.

func (*AssignmentOsType) MarshalJSON

func (s *AssignmentOsType) MarshalJSON() ([]byte, error)

type CancelPatchJobRequest

type CancelPatchJobRequest struct {
}

CancelPatchJobRequest: Message for canceling a patch job.

type EffectiveGuestPolicy

type EffectiveGuestPolicy struct {
	// PackageRepositories: List of package repository configurations assigned to
	// the VM instance.
	PackageRepositories []*EffectiveGuestPolicySourcedPackageRepository `json:"packageRepositories,omitempty"`
	// Packages: List of package configurations assigned to the VM instance.
	Packages []*EffectiveGuestPolicySourcedPackage `json:"packages,omitempty"`
	// SoftwareRecipes: List of recipes assigned to the VM instance.
	SoftwareRecipes []*EffectiveGuestPolicySourcedSoftwareRecipe `json:"softwareRecipes,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "PackageRepositories") 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. "PackageRepositories") 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:"-"`
}

EffectiveGuestPolicy: The effective guest policy that applies to a VM instance.

func (*EffectiveGuestPolicy) MarshalJSON

func (s *EffectiveGuestPolicy) MarshalJSON() ([]byte, error)

type EffectiveGuestPolicySourcedPackage

type EffectiveGuestPolicySourcedPackage struct {
	// Package: A software package to configure on the VM instance.
	Package *Package `json:"package,omitempty"`
	// Source: Name of the guest policy providing this config.
	Source string `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Package") 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. "Package") 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:"-"`
}

EffectiveGuestPolicySourcedPackage: A guest policy package including its source.

func (*EffectiveGuestPolicySourcedPackage) MarshalJSON

func (s *EffectiveGuestPolicySourcedPackage) MarshalJSON() ([]byte, error)

type EffectiveGuestPolicySourcedPackageRepository

type EffectiveGuestPolicySourcedPackageRepository struct {
	// PackageRepository: A software package repository to configure on the VM
	// instance.
	PackageRepository *PackageRepository `json:"packageRepository,omitempty"`
	// Source: Name of the guest policy providing this config.
	Source string `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PackageRepository") 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. "PackageRepository") 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:"-"`
}

EffectiveGuestPolicySourcedPackageRepository: A guest policy package repository including its source.

func (*EffectiveGuestPolicySourcedPackageRepository) MarshalJSON

type EffectiveGuestPolicySourcedSoftwareRecipe

type EffectiveGuestPolicySourcedSoftwareRecipe struct {
	// SoftwareRecipe: A software recipe to configure on the VM instance.
	SoftwareRecipe *SoftwareRecipe `json:"softwareRecipe,omitempty"`
	// Source: Name of the guest policy providing this config.
	Source string `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SoftwareRecipe") 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. "SoftwareRecipe") 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:"-"`
}

EffectiveGuestPolicySourcedSoftwareRecipe: A guest policy recipe including its source.

func (*EffectiveGuestPolicySourcedSoftwareRecipe) MarshalJSON

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 Google 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 Google Cloud Storage object.
	Bucket string `json:"bucket,omitempty"`
	// GenerationNumber: Required. Generation number of the Google 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 Google 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: Google Cloud Storage object representation.

func (*GcsObject) MarshalJSON

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

type GooRepository

type GooRepository 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:"-"`
}

GooRepository: Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.

func (*GooRepository) MarshalJSON

func (s *GooRepository) 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 GuestPolicy

type GuestPolicy struct {
	// Assignment: Required. Specifies the VM instances that are assigned to this
	// policy. This allows you to target sets or groups of VM instances by
	// different parameters such as labels, names, OS, or zones. If left empty, all
	// VM instances underneath this policy are targeted. At the same level in the
	// resource hierarchy (that is within a project), the service prevents the
	// creation of multiple policies that conflict with each other. For more
	// information, see how the service handles assignment conflicts
	// (/compute/docs/os-config-management/create-guest-policy#handle-conflicts).
	Assignment *Assignment `json:"assignment,omitempty"`
	// CreateTime: Output only. Time this guest policy was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Description of the guest policy. Length of the description is
	// limited to 1024 characters.
	Description string `json:"description,omitempty"`
	// Etag: The etag for this guest policy. If this is provided on update, it must
	// match the server's etag.
	Etag string `json:"etag,omitempty"`
	// Name: Required. Unique name of the resource in this project using one of the
	// following forms:
	// `projects/{project_number}/guestPolicies/{guest_policy_id}`.
	Name string `json:"name,omitempty"`
	// PackageRepositories: A list of package repositories to configure on the VM
	// instance. This is done before any other configs are applied so they can use
	// these repos. Package repositories are only configured if the corresponding
	// package manager(s) are available.
	PackageRepositories []*PackageRepository `json:"packageRepositories,omitempty"`
	// Packages: The software packages to be managed by this policy.
	Packages []*Package `json:"packages,omitempty"`
	// Recipes: A list of Recipes to install on the VM instance.
	Recipes []*SoftwareRecipe `json:"recipes,omitempty"`
	// UpdateTime: Output only. Last time this guest policy 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. "Assignment") 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. "Assignment") 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:"-"`
}

GuestPolicy: An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.

func (*GuestPolicy) MarshalJSON

func (s *GuestPolicy) MarshalJSON() ([]byte, error)

type ListGuestPoliciesResponse

type ListGuestPoliciesResponse struct {
	// GuestPolicies: The list of GuestPolicies.
	GuestPolicies []*GuestPolicy `json:"guestPolicies,omitempty"`
	// NextPageToken: A pagination token that can be used to get the next page of
	// guest policies.
	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. "GuestPolicies") 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. "GuestPolicies") 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:"-"`
}

ListGuestPoliciesResponse: A response message for listing guest policies.

func (*ListGuestPoliciesResponse) MarshalJSON

func (s *ListGuestPoliciesResponse) 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 LookupEffectiveGuestPolicyRequest

type LookupEffectiveGuestPolicyRequest struct {
	// OsArchitecture: Architecture of OS running on the instance. The OS Config
	// agent only provides this field for targeting if OS Inventory is enabled for
	// that instance.
	OsArchitecture string `json:"osArchitecture,omitempty"`
	// OsShortName: Short name of the OS running on the instance. The OS Config
	// agent only provides this field for targeting if OS Inventory is enabled for
	// that instance.
	OsShortName string `json:"osShortName,omitempty"`
	// OsVersion: Version of the OS running on the instance. The OS Config agent
	// only provides this field for targeting if OS Inventory is enabled for that
	// VM instance.
	OsVersion string `json:"osVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OsArchitecture") 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. "OsArchitecture") 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:"-"`
}

LookupEffectiveGuestPolicyRequest: A request message for getting the effective guest policy assigned to the instance.

func (*LookupEffectiveGuestPolicyRequest) MarshalJSON

func (s *LookupEffectiveGuestPolicyRequest) 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 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 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 Package

type Package struct {
	// DesiredState: The desired_state the agent should maintain for this package.
	// The default is to ensure the package is installed.
	//
	// Possible values:
	//   "DESIRED_STATE_UNSPECIFIED" - The default is to ensure the package is
	// installed.
	//   "INSTALLED" - The agent ensures that the package is installed.
	//   "UPDATED" - The agent ensures that the package is installed and
	// periodically checks for and install any updates.
	//   "REMOVED" - The agent ensures that the package is not installed and
	// uninstall it if detected.
	DesiredState string `json:"desiredState,omitempty"`
	// Manager: Type of package manager that can be used to install this package.
	// If a system does not have the package manager, the package is not installed
	// or removed no error message is returned. By default, or if you specify
	// `ANY`, the agent attempts to install and remove this package using the
	// default package manager. This is useful when creating a policy that applies
	// to different types of systems. The default behavior is ANY.
	//
	// Possible values:
	//   "MANAGER_UNSPECIFIED" - The default behavior is ANY.
	//   "ANY" - Apply this package config using the default system package
	// manager.
	//   "APT" - Apply this package config only if Apt is available on the system.
	//   "YUM" - Apply this package config only if Yum is available on the system.
	//   "ZYPPER" - Apply this package config only if Zypper is available on the
	// system.
	//   "GOO" - Apply this package config only if GooGet is available on the
	// system.
	Manager string `json:"manager,omitempty"`
	// Name: Required. The name of the package. A package is uniquely identified
	// for conflict validation by checking the package name and the manager(s) that
	// the package targets.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DesiredState") 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. "DesiredState") 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:"-"`
}

Package: Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3`

func (*Package) MarshalJSON

func (s *Package) MarshalJSON() ([]byte, error)

type PackageRepository

type PackageRepository struct {
	// Apt: An Apt Repository.
	Apt *AptRepository `json:"apt,omitempty"`
	// Goo: A Goo Repository.
	Goo *GooRepository `json:"goo,omitempty"`
	// Yum: A Yum Repository.
	Yum *YumRepository `json:"yum,omitempty"`
	// Zypper: A Zypper Repository.
	Zypper *ZypperRepository `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:"-"`
}

PackageRepository: A package repository.

func (*PackageRepository) MarshalJSON

func (s *PackageRepository) 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 at least one of these label sets.
	// This allows targeting of disparate groups, for example "env=prod or
	// env=staging".
	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: Represents a group of VMs that can be identified as having all these labels, for example "env=prod 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 ProjectsGuestPoliciesCreateCall

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

func (*ProjectsGuestPoliciesCreateCall) Context

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

func (*ProjectsGuestPoliciesCreateCall) Do

Do executes the "osconfig.projects.guestPolicies.create" call. Any non-2xx status code is an error. Response headers are in either *GuestPolicy.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 (*ProjectsGuestPoliciesCreateCall) Fields

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

func (*ProjectsGuestPoliciesCreateCall) GuestPolicyId

GuestPolicyId sets the optional parameter "guestPolicyId": Required. The logical name of the guest policy 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 (*ProjectsGuestPoliciesCreateCall) Header

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

type ProjectsGuestPoliciesDeleteCall

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

func (*ProjectsGuestPoliciesDeleteCall) Context

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

func (*ProjectsGuestPoliciesDeleteCall) Do

Do executes the "osconfig.projects.guestPolicies.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 (*ProjectsGuestPoliciesDeleteCall) Fields

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

func (*ProjectsGuestPoliciesDeleteCall) Header

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

type ProjectsGuestPoliciesGetCall

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

func (*ProjectsGuestPoliciesGetCall) Context

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

func (*ProjectsGuestPoliciesGetCall) Do

Do executes the "osconfig.projects.guestPolicies.get" call. Any non-2xx status code is an error. Response headers are in either *GuestPolicy.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 (*ProjectsGuestPoliciesGetCall) Fields

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

func (*ProjectsGuestPoliciesGetCall) Header

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

func (*ProjectsGuestPoliciesGetCall) 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 ProjectsGuestPoliciesListCall

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

func (*ProjectsGuestPoliciesListCall) Context

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

func (*ProjectsGuestPoliciesListCall) Do

Do executes the "osconfig.projects.guestPolicies.list" call. Any non-2xx status code is an error. Response headers are in either *ListGuestPoliciesResponse.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 (*ProjectsGuestPoliciesListCall) Fields

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

func (*ProjectsGuestPoliciesListCall) Header

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

func (*ProjectsGuestPoliciesListCall) 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 (*ProjectsGuestPoliciesListCall) PageSize

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

func (*ProjectsGuestPoliciesListCall) PageToken

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

func (*ProjectsGuestPoliciesListCall) 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 ProjectsGuestPoliciesPatchCall

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

func (*ProjectsGuestPoliciesPatchCall) Context

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

func (*ProjectsGuestPoliciesPatchCall) Do

Do executes the "osconfig.projects.guestPolicies.patch" call. Any non-2xx status code is an error. Response headers are in either *GuestPolicy.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 (*ProjectsGuestPoliciesPatchCall) Fields

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

func (*ProjectsGuestPoliciesPatchCall) Header

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

func (*ProjectsGuestPoliciesPatchCall) UpdateMask

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

type ProjectsGuestPoliciesService

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

func NewProjectsGuestPoliciesService

func NewProjectsGuestPoliciesService(s *Service) *ProjectsGuestPoliciesService

func (*ProjectsGuestPoliciesService) Create

Create: Create an OS Config guest policy.

  • parent: The resource name of the parent using one of the following forms: `projects/{project_number}`.

func (*ProjectsGuestPoliciesService) Delete

Delete: Delete an OS Config guest policy.

  • name: The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

func (*ProjectsGuestPoliciesService) Get

Get: Get an OS Config guest policy.

  • name: The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

func (*ProjectsGuestPoliciesService) List

List: Get a page of OS Config guest policies.

  • parent: The resource name of the parent using one of the following forms: `projects/{project_number}`.

func (*ProjectsGuestPoliciesService) Patch

Patch: Update an OS Config guest policy.

  • name: Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.

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.61.0

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

func (*ProjectsPatchDeploymentsPatchCall) Context added in v0.61.0

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

func (*ProjectsPatchDeploymentsPatchCall) Do added in v0.61.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.61.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.61.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.61.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.61.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 {
	GuestPolicies *ProjectsGuestPoliciesService

	PatchDeployments *ProjectsPatchDeploymentsService

	PatchJobs *ProjectsPatchJobsService

	Zones *ProjectsZonesService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ProjectsZonesInstancesLookupEffectiveGuestPolicyCall

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

func (*ProjectsZonesInstancesLookupEffectiveGuestPolicyCall) Context

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

func (*ProjectsZonesInstancesLookupEffectiveGuestPolicyCall) Do

Do executes the "osconfig.projects.zones.instances.lookupEffectiveGuestPolicy" call. Any non-2xx status code is an error. Response headers are in either *EffectiveGuestPolicy.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 (*ProjectsZonesInstancesLookupEffectiveGuestPolicyCall) Fields

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

func (*ProjectsZonesInstancesLookupEffectiveGuestPolicyCall) Header

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

type ProjectsZonesInstancesService

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

func NewProjectsZonesInstancesService

func NewProjectsZonesInstancesService(s *Service) *ProjectsZonesInstancesService

func (*ProjectsZonesInstancesService) LookupEffectiveGuestPolicy

func (r *ProjectsZonesInstancesService) LookupEffectiveGuestPolicy(instance string, lookupeffectiveguestpolicyrequest *LookupEffectiveGuestPolicyRequest) *ProjectsZonesInstancesLookupEffectiveGuestPolicyCall

LookupEffectiveGuestPolicy: Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.

- instance: The VM instance whose policies are being looked up.

type ProjectsZonesService

type ProjectsZonesService struct {
	Instances *ProjectsZonesInstancesService
	// contains filtered or unexported fields
}

func NewProjectsZonesService

func NewProjectsZonesService(s *Service) *ProjectsZonesService

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 SoftwareRecipe

type SoftwareRecipe struct {
	// Artifacts: Resources available to be used in the steps in the recipe.
	Artifacts []*SoftwareRecipeArtifact `json:"artifacts,omitempty"`
	// DesiredState: Default is INSTALLED. The desired state the agent should
	// maintain for this recipe. INSTALLED: The software recipe is installed on the
	// instance but won't be updated to new versions. UPDATED: The software recipe
	// is installed on the instance. The recipe is updated to a higher version, if
	// a higher version of the recipe is assigned to this instance. REMOVE: Remove
	// is unsupported for software recipes and attempts to create or update a
	// recipe to the REMOVE state is rejected.
	//
	// Possible values:
	//   "DESIRED_STATE_UNSPECIFIED" - The default is to ensure the package is
	// installed.
	//   "INSTALLED" - The agent ensures that the package is installed.
	//   "UPDATED" - The agent ensures that the package is installed and
	// periodically checks for and install any updates.
	//   "REMOVED" - The agent ensures that the package is not installed and
	// uninstall it if detected.
	DesiredState string `json:"desiredState,omitempty"`
	// InstallSteps: Actions to be taken for installing this recipe. On failure it
	// stops executing steps and does not attempt another installation. Any steps
	// taken (including partially completed steps) are not rolled back.
	InstallSteps []*SoftwareRecipeStep `json:"installSteps,omitempty"`
	// Name: Required. Unique identifier for the recipe. Only one recipe with a
	// given name is installed on an instance. Names are also used to identify
	// resources which helps to determine whether guest policies have conflicts.
	// This means that requests to create multiple recipes with the same name and
	// version are rejected since they could potentially have conflicting
	// assignments.
	Name string `json:"name,omitempty"`
	// UpdateSteps: Actions to be taken for updating this recipe. On failure it
	// stops executing steps and does not attempt another update for this recipe.
	// Any steps taken (including partially completed steps) are not rolled back.
	UpdateSteps []*SoftwareRecipeStep `json:"updateSteps,omitempty"`
	// Version: The version of this software recipe. Version can be up to 4 period
	// separated numbers (e.g. 12.34.56.78).
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Artifacts") 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. "Artifacts") 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:"-"`
}

SoftwareRecipe: A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step.

func (*SoftwareRecipe) MarshalJSON

func (s *SoftwareRecipe) MarshalJSON() ([]byte, error)

type SoftwareRecipeArtifact

type SoftwareRecipeArtifact struct {
	// AllowInsecure: Defaults to false. When false, recipes are subject to
	// validations based on the artifact type: Remote: A checksum must be
	// specified, and only protocols with transport-layer security are permitted.
	// GCS: An object generation number must be specified.
	AllowInsecure bool `json:"allowInsecure,omitempty"`
	// Gcs: A Google Cloud Storage artifact.
	Gcs *SoftwareRecipeArtifactGcs `json:"gcs,omitempty"`
	// Id: Required. Id of the artifact, which the installation and update steps of
	// this recipe can reference. Artifacts in a recipe cannot have the same id.
	Id string `json:"id,omitempty"`
	// Remote: A generic remote artifact.
	Remote *SoftwareRecipeArtifactRemote `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:"-"`
}

SoftwareRecipeArtifact: Specifies a resource to be used in the recipe.

func (*SoftwareRecipeArtifact) MarshalJSON

func (s *SoftwareRecipeArtifact) MarshalJSON() ([]byte, error)

type SoftwareRecipeArtifactGcs

type SoftwareRecipeArtifactGcs struct {
	// Bucket: Bucket of the Google Cloud Storage object. Given an example URL:
	// `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would
	// be `my-bucket`.
	Bucket string `json:"bucket,omitempty"`
	// Generation: Must be provided if allow_insecure is false. Generation number
	// of the Google Cloud Storage object.
	// `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would
	// be `1234567`.
	Generation int64 `json:"generation,omitempty,string"`
	// Object: Name of the Google Cloud Storage object. As specified [here]
	// (https://cloud.google.com/storage/docs/naming#objectnames) Given an example
	// URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value
	// would be `foo/bar`.
	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:"-"`
}

SoftwareRecipeArtifactGcs: Specifies an artifact available as a Google Cloud Storage object.

func (*SoftwareRecipeArtifactGcs) MarshalJSON

func (s *SoftwareRecipeArtifactGcs) MarshalJSON() ([]byte, error)

type SoftwareRecipeArtifactRemote

type SoftwareRecipeArtifactRemote struct {
	// Checksum: Must be provided if `allow_insecure` is `false`. SHA256 checksum
	// in hex format, to compare to the checksum of the artifact. If the checksum
	// is not empty and it doesn't match the artifact then the recipe installation
	// fails before running any of the steps.
	Checksum string `json:"checksum,omitempty"`
	// Uri: 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. "Checksum") 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. "Checksum") 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:"-"`
}

SoftwareRecipeArtifactRemote: Specifies an artifact available via some URI.

func (*SoftwareRecipeArtifactRemote) MarshalJSON

func (s *SoftwareRecipeArtifactRemote) MarshalJSON() ([]byte, error)

type SoftwareRecipeStep

type SoftwareRecipeStep struct {
	// ArchiveExtraction: Extracts an archive into the specified directory.
	ArchiveExtraction *SoftwareRecipeStepExtractArchive `json:"archiveExtraction,omitempty"`
	// DpkgInstallation: Installs a deb file via dpkg.
	DpkgInstallation *SoftwareRecipeStepInstallDpkg `json:"dpkgInstallation,omitempty"`
	// FileCopy: Copies a file onto the instance.
	FileCopy *SoftwareRecipeStepCopyFile `json:"fileCopy,omitempty"`
	// FileExec: Executes an artifact or local file.
	FileExec *SoftwareRecipeStepExecFile `json:"fileExec,omitempty"`
	// MsiInstallation: Installs an MSI file.
	MsiInstallation *SoftwareRecipeStepInstallMsi `json:"msiInstallation,omitempty"`
	// RpmInstallation: Installs an rpm file via the rpm utility.
	RpmInstallation *SoftwareRecipeStepInstallRpm `json:"rpmInstallation,omitempty"`
	// ScriptRun: Runs commands in a shell.
	ScriptRun *SoftwareRecipeStepRunScript `json:"scriptRun,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ArchiveExtraction") 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. "ArchiveExtraction") 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:"-"`
}

SoftwareRecipeStep: An action that can be taken as part of installing or updating a recipe.

func (*SoftwareRecipeStep) MarshalJSON

func (s *SoftwareRecipeStep) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepCopyFile

type SoftwareRecipeStepCopyFile struct {
	// ArtifactId: Required. The id of the relevant artifact in the recipe.
	ArtifactId string `json:"artifactId,omitempty"`
	// Destination: Required. The absolute path on the instance to put the file.
	Destination string `json:"destination,omitempty"`
	// Overwrite: Whether to allow this step to overwrite existing files. If this
	// is false and the file already exists the file is not overwritten and the
	// step is considered a success. Defaults to false.
	Overwrite bool `json:"overwrite,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"`
	// ForceSendFields is a list of field names (e.g. "ArtifactId") 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. "ArtifactId") 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:"-"`
}

SoftwareRecipeStepCopyFile: Copies the artifact to the specified path on the instance.

func (*SoftwareRecipeStepCopyFile) MarshalJSON

func (s *SoftwareRecipeStepCopyFile) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepExecFile

type SoftwareRecipeStepExecFile struct {
	// AllowedExitCodes: Defaults to [0]. A list of possible return values that the
	// program can return to indicate a success.
	AllowedExitCodes []int64 `json:"allowedExitCodes,omitempty"`
	// Args: Arguments to be passed to the provided executable.
	Args []string `json:"args,omitempty"`
	// ArtifactId: The id of the relevant artifact in the recipe.
	ArtifactId string `json:"artifactId,omitempty"`
	// LocalPath: The absolute path of the file on the local filesystem.
	LocalPath string `json:"localPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedExitCodes") 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. "AllowedExitCodes") 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:"-"`
}

SoftwareRecipeStepExecFile: Executes an artifact or local file.

func (*SoftwareRecipeStepExecFile) MarshalJSON

func (s *SoftwareRecipeStepExecFile) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepExtractArchive

type SoftwareRecipeStepExtractArchive struct {
	// ArtifactId: Required. The id of the relevant artifact in the recipe.
	ArtifactId string `json:"artifactId,omitempty"`
	// Destination: Directory to extract archive to. Defaults to `/` on Linux or
	// `C:\` on Windows.
	Destination string `json:"destination,omitempty"`
	// Type: Required. The type of the archive to extract.
	//
	// Possible values:
	//   "ARCHIVE_TYPE_UNSPECIFIED" - Indicates that the archive type isn't
	// specified.
	//   "TAR" - Indicates that the archive is a tar archive with no encryption.
	//   "TAR_GZIP" - Indicates that the archive is a tar archive with gzip
	// encryption.
	//   "TAR_BZIP" - Indicates that the archive is a tar archive with bzip
	// encryption.
	//   "TAR_LZMA" - Indicates that the archive is a tar archive with lzma
	// encryption.
	//   "TAR_XZ" - Indicates that the archive is a tar archive with xz encryption.
	//   "ZIP" - Indicates that the archive is a zip archive.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ArtifactId") 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. "ArtifactId") 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:"-"`
}

SoftwareRecipeStepExtractArchive: Extracts an archive of the type specified in the specified directory.

func (*SoftwareRecipeStepExtractArchive) MarshalJSON

func (s *SoftwareRecipeStepExtractArchive) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepInstallDpkg

type SoftwareRecipeStepInstallDpkg struct {
	// ArtifactId: Required. The id of the relevant artifact in the recipe.
	ArtifactId string `json:"artifactId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ArtifactId") 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. "ArtifactId") 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:"-"`
}

SoftwareRecipeStepInstallDpkg: Installs a deb via dpkg.

func (*SoftwareRecipeStepInstallDpkg) MarshalJSON

func (s *SoftwareRecipeStepInstallDpkg) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepInstallMsi

type SoftwareRecipeStepInstallMsi struct {
	// AllowedExitCodes: Return codes that indicate that the software installed or
	// updated successfully. Behaviour defaults to [0]
	AllowedExitCodes []int64 `json:"allowedExitCodes,omitempty"`
	// ArtifactId: Required. The id of the relevant artifact in the recipe.
	ArtifactId string `json:"artifactId,omitempty"`
	// Flags: The flags to use when installing the MSI defaults to ["/i"] (i.e. the
	// install flag).
	Flags []string `json:"flags,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedExitCodes") 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. "AllowedExitCodes") 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:"-"`
}

SoftwareRecipeStepInstallMsi: Installs an MSI file.

func (*SoftwareRecipeStepInstallMsi) MarshalJSON

func (s *SoftwareRecipeStepInstallMsi) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepInstallRpm

type SoftwareRecipeStepInstallRpm struct {
	// ArtifactId: Required. The id of the relevant artifact in the recipe.
	ArtifactId string `json:"artifactId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ArtifactId") 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. "ArtifactId") 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:"-"`
}

SoftwareRecipeStepInstallRpm: Installs an rpm file via the rpm utility.

func (*SoftwareRecipeStepInstallRpm) MarshalJSON

func (s *SoftwareRecipeStepInstallRpm) MarshalJSON() ([]byte, error)

type SoftwareRecipeStepRunScript

type SoftwareRecipeStepRunScript struct {
	// AllowedExitCodes: Return codes that indicate that the software installed or
	// updated successfully. Behaviour defaults to [0]
	AllowedExitCodes []int64 `json:"allowedExitCodes,omitempty"`
	// Interpreter: The script interpreter to use to run the script. If no
	// interpreter is specified the script is executed directly, which likely only
	// succeed for scripts with shebang lines
	// (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
	//
	// Possible values:
	//   "INTERPRETER_UNSPECIFIED" - Default value for ScriptType.
	//   "SHELL" - Indicates that the script is run with `/bin/sh` on Linux and
	// `cmd` on windows.
	//   "POWERSHELL" - Indicates that the script is run with powershell.
	Interpreter string `json:"interpreter,omitempty"`
	// Script: Required. The shell script to be executed.
	Script string `json:"script,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedExitCodes") 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. "AllowedExitCodes") 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:"-"`
}

SoftwareRecipeStepRunScript: Runs a script through an interpreter.

func (*SoftwareRecipeStepRunScript) MarshalJSON

func (s *SoftwareRecipeStepRunScript) MarshalJSON() ([]byte, error)

type TimeOfDay

type TimeOfDay struct {
	// Hours: Hours of day in 24 hour format. Should be from 0 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 hour of day. Must be from 0 to 59.
	Minutes int64 `json:"minutes,omitempty"`
	// Nanos: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
	Nanos int64 `json:"nanos,omitempty"`
	// Seconds: Seconds of minutes of the time. Must normally be from 0 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, e.g. "America/New_York".
	Id string `json:"id,omitempty"`
	// Version: Optional. IANA Time Zone Database version number, e.g. "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 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 day of the month
	// and this `day_offset` value is set to `3`, the patch deployment takes place
	// three days after the second Tuesday of the month. If this value is negative,
	// for example -5, the patches are deployed five days before 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 YumRepository

type YumRepository 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
	// guest policy 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:"-"`
}

YumRepository: Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`.

func (*YumRepository) MarshalJSON

func (s *YumRepository) 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 ZypperRepository

type ZypperRepository 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
	// guest policy 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:"-"`
}

ZypperRepository: Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`.

func (*ZypperRepository) MarshalJSON

func (s *ZypperRepository) 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