Constants
OsConfigService_ExecutePatchJob_FullMethodName, OsConfigService_GetPatchJob_FullMethodName, OsConfigService_CancelPatchJob_FullMethodName, OsConfigService_ListPatchJobs_FullMethodName, OsConfigService_ListPatchJobInstanceDetails_FullMethodName, OsConfigService_CreatePatchDeployment_FullMethodName, OsConfigService_GetPatchDeployment_FullMethodName, OsConfigService_ListPatchDeployments_FullMethodName, OsConfigService_DeletePatchDeployment_FullMethodName, OsConfigService_UpdatePatchDeployment_FullMethodName, OsConfigService_PausePatchDeployment_FullMethodName, OsConfigService_ResumePatchDeployment_FullMethodName, OsConfigService_CreateGuestPolicy_FullMethodName, OsConfigService_GetGuestPolicy_FullMethodName, OsConfigService_ListGuestPolicies_FullMethodName, OsConfigService_UpdateGuestPolicy_FullMethodName, OsConfigService_DeleteGuestPolicy_FullMethodName, OsConfigService_LookupEffectiveGuestPolicy_FullMethodName
const (
OsConfigService_ExecutePatchJob_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/ExecutePatchJob"
OsConfigService_GetPatchJob_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/GetPatchJob"
OsConfigService_CancelPatchJob_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/CancelPatchJob"
OsConfigService_ListPatchJobs_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/ListPatchJobs"
OsConfigService_ListPatchJobInstanceDetails_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/ListPatchJobInstanceDetails"
OsConfigService_CreatePatchDeployment_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/CreatePatchDeployment"
OsConfigService_GetPatchDeployment_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/GetPatchDeployment"
OsConfigService_ListPatchDeployments_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/ListPatchDeployments"
OsConfigService_DeletePatchDeployment_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/DeletePatchDeployment"
OsConfigService_UpdatePatchDeployment_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/UpdatePatchDeployment"
OsConfigService_PausePatchDeployment_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/PausePatchDeployment"
OsConfigService_ResumePatchDeployment_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/ResumePatchDeployment"
OsConfigService_CreateGuestPolicy_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/CreateGuestPolicy"
OsConfigService_GetGuestPolicy_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/GetGuestPolicy"
OsConfigService_ListGuestPolicies_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/ListGuestPolicies"
OsConfigService_UpdateGuestPolicy_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/UpdateGuestPolicy"
OsConfigService_DeleteGuestPolicy_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/DeleteGuestPolicy"
OsConfigService_LookupEffectiveGuestPolicy_FullMethodName = "/google.cloud.osconfig.v1beta.OsConfigService/LookupEffectiveGuestPolicy"
)Variables
DesiredState_name, DesiredState_value
var (
DesiredState_name = map[int32]string{
0: "DESIRED_STATE_UNSPECIFIED",
1: "INSTALLED",
2: "UPDATED",
3: "REMOVED",
}
DesiredState_value = map[string]int32{
"DESIRED_STATE_UNSPECIFIED": 0,
"INSTALLED": 1,
"UPDATED": 2,
"REMOVED": 3,
}
)Enum value maps for DesiredState.
Package_Manager_name, Package_Manager_value
var (
Package_Manager_name = map[int32]string{
0: "MANAGER_UNSPECIFIED",
1: "ANY",
2: "APT",
3: "YUM",
4: "ZYPPER",
5: "GOO",
}
Package_Manager_value = map[string]int32{
"MANAGER_UNSPECIFIED": 0,
"ANY": 1,
"APT": 2,
"YUM": 3,
"ZYPPER": 4,
"GOO": 5,
}
)Enum value maps for Package_Manager.
AptRepository_ArchiveType_name, AptRepository_ArchiveType_value
var (
AptRepository_ArchiveType_name = map[int32]string{
0: "ARCHIVE_TYPE_UNSPECIFIED",
1: "DEB",
2: "DEB_SRC",
}
AptRepository_ArchiveType_value = map[string]int32{
"ARCHIVE_TYPE_UNSPECIFIED": 0,
"DEB": 1,
"DEB_SRC": 2,
}
)Enum value maps for AptRepository_ArchiveType.
SoftwareRecipe_Step_ExtractArchive_ArchiveType_name, SoftwareRecipe_Step_ExtractArchive_ArchiveType_value
var (
SoftwareRecipe_Step_ExtractArchive_ArchiveType_name = map[int32]string{
0: "ARCHIVE_TYPE_UNSPECIFIED",
1: "TAR",
2: "TAR_GZIP",
3: "TAR_BZIP",
4: "TAR_LZMA",
5: "TAR_XZ",
11: "ZIP",
}
SoftwareRecipe_Step_ExtractArchive_ArchiveType_value = map[string]int32{
"ARCHIVE_TYPE_UNSPECIFIED": 0,
"TAR": 1,
"TAR_GZIP": 2,
"TAR_BZIP": 3,
"TAR_LZMA": 4,
"TAR_XZ": 5,
"ZIP": 11,
}
)Enum value maps for SoftwareRecipe_Step_ExtractArchive_ArchiveType.
SoftwareRecipe_Step_RunScript_Interpreter_name, SoftwareRecipe_Step_RunScript_Interpreter_value
var (
SoftwareRecipe_Step_RunScript_Interpreter_name = map[int32]string{
0: "INTERPRETER_UNSPECIFIED",
1: "SHELL",
3: "POWERSHELL",
}
SoftwareRecipe_Step_RunScript_Interpreter_value = map[string]int32{
"INTERPRETER_UNSPECIFIED": 0,
"SHELL": 1,
"POWERSHELL": 3,
}
)Enum value maps for SoftwareRecipe_Step_RunScript_Interpreter.
PatchDeployment_State_name, PatchDeployment_State_value
var (
PatchDeployment_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "PAUSED",
}
PatchDeployment_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"PAUSED": 2,
}
)Enum value maps for PatchDeployment_State.
RecurringSchedule_Frequency_name, RecurringSchedule_Frequency_value
var (
RecurringSchedule_Frequency_name = map[int32]string{
0: "FREQUENCY_UNSPECIFIED",
1: "WEEKLY",
2: "MONTHLY",
3: "DAILY",
}
RecurringSchedule_Frequency_value = map[string]int32{
"FREQUENCY_UNSPECIFIED": 0,
"WEEKLY": 1,
"MONTHLY": 2,
"DAILY": 3,
}
)Enum value maps for RecurringSchedule_Frequency.
PatchJob_State_name, PatchJob_State_value
var (
PatchJob_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "STARTED",
2: "INSTANCE_LOOKUP",
3: "PATCHING",
4: "SUCCEEDED",
5: "COMPLETED_WITH_ERRORS",
6: "CANCELED",
7: "TIMED_OUT",
}
PatchJob_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTED": 1,
"INSTANCE_LOOKUP": 2,
"PATCHING": 3,
"SUCCEEDED": 4,
"COMPLETED_WITH_ERRORS": 5,
"CANCELED": 6,
"TIMED_OUT": 7,
}
)Enum value maps for PatchJob_State.
PatchConfig_RebootConfig_name, PatchConfig_RebootConfig_value
var (
PatchConfig_RebootConfig_name = map[int32]string{
0: "REBOOT_CONFIG_UNSPECIFIED",
1: "DEFAULT",
2: "ALWAYS",
3: "NEVER",
}
PatchConfig_RebootConfig_value = map[string]int32{
"REBOOT_CONFIG_UNSPECIFIED": 0,
"DEFAULT": 1,
"ALWAYS": 2,
"NEVER": 3,
}
)Enum value maps for PatchConfig_RebootConfig.
Instance_PatchState_name, Instance_PatchState_value
var (
Instance_PatchState_name = map[int32]string{
0: "PATCH_STATE_UNSPECIFIED",
1: "PENDING",
2: "INACTIVE",
3: "NOTIFIED",
4: "STARTED",
5: "DOWNLOADING_PATCHES",
6: "APPLYING_PATCHES",
7: "REBOOTING",
8: "SUCCEEDED",
9: "SUCCEEDED_REBOOT_REQUIRED",
10: "FAILED",
11: "ACKED",
12: "TIMED_OUT",
13: "RUNNING_PRE_PATCH_STEP",
14: "RUNNING_POST_PATCH_STEP",
15: "NO_AGENT_DETECTED",
}
Instance_PatchState_value = map[string]int32{
"PATCH_STATE_UNSPECIFIED": 0,
"PENDING": 1,
"INACTIVE": 2,
"NOTIFIED": 3,
"STARTED": 4,
"DOWNLOADING_PATCHES": 5,
"APPLYING_PATCHES": 6,
"REBOOTING": 7,
"SUCCEEDED": 8,
"SUCCEEDED_REBOOT_REQUIRED": 9,
"FAILED": 10,
"ACKED": 11,
"TIMED_OUT": 12,
"RUNNING_PRE_PATCH_STEP": 13,
"RUNNING_POST_PATCH_STEP": 14,
"NO_AGENT_DETECTED": 15,
}
)Enum value maps for Instance_PatchState.
AptSettings_Type_name, AptSettings_Type_value
var (
AptSettings_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "DIST",
2: "UPGRADE",
}
AptSettings_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"DIST": 1,
"UPGRADE": 2,
}
)Enum value maps for AptSettings_Type.
WindowsUpdateSettings_Classification_name, WindowsUpdateSettings_Classification_value
var (
WindowsUpdateSettings_Classification_name = map[int32]string{
0: "CLASSIFICATION_UNSPECIFIED",
1: "CRITICAL",
2: "SECURITY",
3: "DEFINITION",
4: "DRIVER",
5: "FEATURE_PACK",
6: "SERVICE_PACK",
7: "TOOL",
8: "UPDATE_ROLLUP",
9: "UPDATE",
}
WindowsUpdateSettings_Classification_value = map[string]int32{
"CLASSIFICATION_UNSPECIFIED": 0,
"CRITICAL": 1,
"SECURITY": 2,
"DEFINITION": 3,
"DRIVER": 4,
"FEATURE_PACK": 5,
"SERVICE_PACK": 6,
"TOOL": 7,
"UPDATE_ROLLUP": 8,
"UPDATE": 9,
}
)Enum value maps for WindowsUpdateSettings_Classification.
ExecStepConfig_Interpreter_name, ExecStepConfig_Interpreter_value
var (
ExecStepConfig_Interpreter_name = map[int32]string{
0: "INTERPRETER_UNSPECIFIED",
1: "SHELL",
2: "POWERSHELL",
}
ExecStepConfig_Interpreter_value = map[string]int32{
"INTERPRETER_UNSPECIFIED": 0,
"SHELL": 1,
"POWERSHELL": 2,
}
)Enum value maps for ExecStepConfig_Interpreter.
PatchRollout_Mode_name, PatchRollout_Mode_value
var (
PatchRollout_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "ZONE_BY_ZONE",
2: "CONCURRENT_ZONES",
}
PatchRollout_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"ZONE_BY_ZONE": 1,
"CONCURRENT_ZONES": 2,
}
)Enum value maps for PatchRollout_Mode.
File_google_cloud_osconfig_v1beta_guest_policies_proto
var File_google_cloud_osconfig_v1beta_guest_policies_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_v1beta_osconfig_common_proto
var File_google_cloud_osconfig_v1beta_osconfig_common_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_v1beta_osconfig_service_proto
var File_google_cloud_osconfig_v1beta_osconfig_service_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_v1beta_patch_deployments_proto
var File_google_cloud_osconfig_v1beta_patch_deployments_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_v1beta_patch_jobs_proto
var File_google_cloud_osconfig_v1beta_patch_jobs_proto protoreflect.FileDescriptorOsConfigService_ServiceDesc
var OsConfigService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.osconfig.v1beta.OsConfigService",
HandlerType: (*OsConfigServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ExecutePatchJob",
Handler: _OsConfigService_ExecutePatchJob_Handler,
},
{
MethodName: "GetPatchJob",
Handler: _OsConfigService_GetPatchJob_Handler,
},
{
MethodName: "CancelPatchJob",
Handler: _OsConfigService_CancelPatchJob_Handler,
},
{
MethodName: "ListPatchJobs",
Handler: _OsConfigService_ListPatchJobs_Handler,
},
{
MethodName: "ListPatchJobInstanceDetails",
Handler: _OsConfigService_ListPatchJobInstanceDetails_Handler,
},
{
MethodName: "CreatePatchDeployment",
Handler: _OsConfigService_CreatePatchDeployment_Handler,
},
{
MethodName: "GetPatchDeployment",
Handler: _OsConfigService_GetPatchDeployment_Handler,
},
{
MethodName: "ListPatchDeployments",
Handler: _OsConfigService_ListPatchDeployments_Handler,
},
{
MethodName: "DeletePatchDeployment",
Handler: _OsConfigService_DeletePatchDeployment_Handler,
},
{
MethodName: "UpdatePatchDeployment",
Handler: _OsConfigService_UpdatePatchDeployment_Handler,
},
{
MethodName: "PausePatchDeployment",
Handler: _OsConfigService_PausePatchDeployment_Handler,
},
{
MethodName: "ResumePatchDeployment",
Handler: _OsConfigService_ResumePatchDeployment_Handler,
},
{
MethodName: "CreateGuestPolicy",
Handler: _OsConfigService_CreateGuestPolicy_Handler,
},
{
MethodName: "GetGuestPolicy",
Handler: _OsConfigService_GetGuestPolicy_Handler,
},
{
MethodName: "ListGuestPolicies",
Handler: _OsConfigService_ListGuestPolicies_Handler,
},
{
MethodName: "UpdateGuestPolicy",
Handler: _OsConfigService_UpdateGuestPolicy_Handler,
},
{
MethodName: "DeleteGuestPolicy",
Handler: _OsConfigService_DeleteGuestPolicy_Handler,
},
{
MethodName: "LookupEffectiveGuestPolicy",
Handler: _OsConfigService_LookupEffectiveGuestPolicy_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/osconfig/v1beta/osconfig_service.proto",
}OsConfigService_ServiceDesc is the grpc.ServiceDesc for OsConfigService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterOsConfigServiceServer
func RegisterOsConfigServiceServer(s grpc.ServiceRegistrar, srv OsConfigServiceServer)AptRepository
type AptRepository struct {
// Type of archive files in this repository. The default behavior is DEB.
ArchiveType AptRepository_ArchiveType `protobuf:"varint,1,opt,name=archive_type,json=archiveType,proto3,enum=google.cloud.osconfig.v1beta.AptRepository_ArchiveType" json:"archive_type,omitempty"`
// Required. URI for this repository.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Required. Distribution of this repository.
Distribution string `protobuf:"bytes,3,opt,name=distribution,proto3" json:"distribution,omitempty"`
// Required. List of components for this repository. Must contain at least one item.
Components []string `protobuf:"bytes,4,rep,name=components,proto3" json:"components,omitempty"`
// 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 `protobuf:"bytes,5,opt,name=gpg_key,json=gpgKey,proto3" json:"gpg_key,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*AptRepository) Descriptor() ([]byte, []int)Deprecated: Use AptRepository.ProtoReflect.Descriptor instead.
func (*AptRepository) GetArchiveType
func (x *AptRepository) GetArchiveType() AptRepository_ArchiveTypefunc (*AptRepository) GetComponents
func (x *AptRepository) GetComponents() []stringfunc (*AptRepository) GetDistribution
func (x *AptRepository) GetDistribution() stringfunc (*AptRepository) GetGpgKey
func (x *AptRepository) GetGpgKey() stringfunc (*AptRepository) GetUri
func (x *AptRepository) GetUri() stringfunc (*AptRepository) ProtoMessage
func (*AptRepository) ProtoMessage()func (*AptRepository) ProtoReflect
func (x *AptRepository) ProtoReflect() protoreflect.Messagefunc (*AptRepository) Reset
func (x *AptRepository) Reset()func (*AptRepository) String
func (x *AptRepository) String() stringAptRepository_ArchiveType
type AptRepository_ArchiveType int32Type of archive.
AptRepository_ARCHIVE_TYPE_UNSPECIFIED, AptRepository_DEB, AptRepository_DEB_SRC
const (
// Unspecified.
AptRepository_ARCHIVE_TYPE_UNSPECIFIED AptRepository_ArchiveType = 0
// DEB indicates that the archive contains binary files.
AptRepository_DEB AptRepository_ArchiveType = 1
// DEB_SRC indicates that the archive contains source files.
AptRepository_DEB_SRC AptRepository_ArchiveType = 2
)func (AptRepository_ArchiveType) Descriptor
func (AptRepository_ArchiveType) Descriptor() protoreflect.EnumDescriptorfunc (AptRepository_ArchiveType) Enum
func (x AptRepository_ArchiveType) Enum() *AptRepository_ArchiveTypefunc (AptRepository_ArchiveType) EnumDescriptor
func (AptRepository_ArchiveType) EnumDescriptor() ([]byte, []int)Deprecated: Use AptRepository_ArchiveType.Descriptor instead.
func (AptRepository_ArchiveType) Number
func (x AptRepository_ArchiveType) Number() protoreflect.EnumNumberfunc (AptRepository_ArchiveType) String
func (x AptRepository_ArchiveType) String() stringfunc (AptRepository_ArchiveType) Type
func (AptRepository_ArchiveType) Type() protoreflect.EnumTypeAptSettings
type AptSettings struct {
// By changing the type to DIST, the patching is performed
// using `apt-get dist-upgrade` instead.
Type AptSettings_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.osconfig.v1beta.AptSettings_Type" json:"type,omitempty"`
// List of packages to exclude from update. These packages will be excluded
Excludes []string `protobuf:"bytes,2,rep,name=excludes,proto3" json:"excludes,omitempty"`
// 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 `protobuf:"bytes,3,rep,name=exclusive_packages,json=exclusivePackages,proto3" json:"exclusive_packages,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*AptSettings) Descriptor() ([]byte, []int)Deprecated: Use AptSettings.ProtoReflect.Descriptor instead.
func (*AptSettings) GetExcludes
func (x *AptSettings) GetExcludes() []stringfunc (*AptSettings) GetExclusivePackages
func (x *AptSettings) GetExclusivePackages() []stringfunc (*AptSettings) GetType
func (x *AptSettings) GetType() AptSettings_Typefunc (*AptSettings) ProtoMessage
func (*AptSettings) ProtoMessage()func (*AptSettings) ProtoReflect
func (x *AptSettings) ProtoReflect() protoreflect.Messagefunc (*AptSettings) Reset
func (x *AptSettings) Reset()func (*AptSettings) String
func (x *AptSettings) String() stringAptSettings_Type
type AptSettings_Type int32Apt patch type.
AptSettings_TYPE_UNSPECIFIED, AptSettings_DIST, AptSettings_UPGRADE
const (
// By default, upgrade will be performed.
AptSettings_TYPE_UNSPECIFIED AptSettings_Type = 0
// Runs `apt-get dist-upgrade`.
AptSettings_DIST AptSettings_Type = 1
// Runs `apt-get upgrade`.
AptSettings_UPGRADE AptSettings_Type = 2
)func (AptSettings_Type) Descriptor
func (AptSettings_Type) Descriptor() protoreflect.EnumDescriptorfunc (AptSettings_Type) Enum
func (x AptSettings_Type) Enum() *AptSettings_Typefunc (AptSettings_Type) EnumDescriptor
func (AptSettings_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use AptSettings_Type.Descriptor instead.
func (AptSettings_Type) Number
func (x AptSettings_Type) Number() protoreflect.EnumNumberfunc (AptSettings_Type) String
func (x AptSettings_Type) String() stringfunc (AptSettings_Type) Type
func (AptSettings_Type) Type() protoreflect.EnumTypeAssignment
type Assignment struct {
// 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 []*Assignment_GroupLabel `protobuf:"bytes,1,rep,name=group_labels,json=groupLabels,proto3" json:"group_labels,omitempty"`
// 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 `protobuf:"bytes,2,rep,name=zones,proto3" json:"zones,omitempty"`
// 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 `protobuf:"bytes,3,rep,name=instances,proto3" json:"instances,omitempty"`
// 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 `protobuf:"bytes,4,rep,name=instance_name_prefixes,json=instanceNamePrefixes,proto3" json:"instance_name_prefixes,omitempty"`
// 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 []*Assignment_OsType `protobuf:"bytes,5,rep,name=os_types,json=osTypes,proto3" json:"os_types,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*Assignment) Descriptor() ([]byte, []int)Deprecated: Use Assignment.ProtoReflect.Descriptor instead.
func (*Assignment) GetGroupLabels
func (x *Assignment) GetGroupLabels() []*Assignment_GroupLabelfunc (*Assignment) GetInstanceNamePrefixes
func (x *Assignment) GetInstanceNamePrefixes() []stringfunc (*Assignment) GetInstances
func (x *Assignment) GetInstances() []stringfunc (*Assignment) GetOsTypes
func (x *Assignment) GetOsTypes() []*Assignment_OsTypefunc (*Assignment) GetZones
func (x *Assignment) GetZones() []stringfunc (*Assignment) ProtoMessage
func (*Assignment) ProtoMessage()func (*Assignment) ProtoReflect
func (x *Assignment) ProtoReflect() protoreflect.Messagefunc (*Assignment) Reset
func (x *Assignment) Reset()func (*Assignment) String
func (x *Assignment) String() stringAssignment_GroupLabel
type Assignment_GroupLabel struct {
// Google Compute Engine instance labels that must be present for an
// instance to be included in this assignment group.
Labels map[string]string `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".
func (*Assignment_GroupLabel) Descriptor
func (*Assignment_GroupLabel) Descriptor() ([]byte, []int)Deprecated: Use Assignment_GroupLabel.ProtoReflect.Descriptor instead.
func (*Assignment_GroupLabel) GetLabels
func (x *Assignment_GroupLabel) GetLabels() map[string]stringfunc (*Assignment_GroupLabel) ProtoMessage
func (*Assignment_GroupLabel) ProtoMessage()func (*Assignment_GroupLabel) ProtoReflect
func (x *Assignment_GroupLabel) ProtoReflect() protoreflect.Messagefunc (*Assignment_GroupLabel) Reset
func (x *Assignment_GroupLabel) Reset()func (*Assignment_GroupLabel) String
func (x *Assignment_GroupLabel) String() stringAssignment_OsType
type Assignment_OsType struct {
// Targets VM instances with OS Inventory enabled and having the following
// OS short name, for example "debian" or "windows".
OsShortName string `protobuf:"bytes,1,opt,name=os_short_name,json=osShortName,proto3" json:"os_short_name,omitempty"`
// Targets VM instances with OS Inventory enabled and having the following
// following OS version.
OsVersion string `protobuf:"bytes,2,opt,name=os_version,json=osVersion,proto3" json:"os_version,omitempty"`
// Targets VM instances with OS Inventory enabled and having the following
// OS architecture.
OsArchitecture string `protobuf:"bytes,3,opt,name=os_architecture,json=osArchitecture,proto3" json:"os_architecture,omitempty"`
// contains filtered or unexported fields
}Defines the criteria for selecting VM Instances by OS type.
func (*Assignment_OsType) Descriptor
func (*Assignment_OsType) Descriptor() ([]byte, []int)Deprecated: Use Assignment_OsType.ProtoReflect.Descriptor instead.
func (*Assignment_OsType) GetOsArchitecture
func (x *Assignment_OsType) GetOsArchitecture() stringfunc (*Assignment_OsType) GetOsShortName
func (x *Assignment_OsType) GetOsShortName() stringfunc (*Assignment_OsType) GetOsVersion
func (x *Assignment_OsType) GetOsVersion() stringfunc (*Assignment_OsType) ProtoMessage
func (*Assignment_OsType) ProtoMessage()func (*Assignment_OsType) ProtoReflect
func (x *Assignment_OsType) ProtoReflect() protoreflect.Messagefunc (*Assignment_OsType) Reset
func (x *Assignment_OsType) Reset()func (*Assignment_OsType) String
func (x *Assignment_OsType) String() stringCancelPatchJobRequest
type CancelPatchJobRequest struct {
// Required. Name of the patch in the form `projects/*/patchJobs/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for canceling a patch job.
func (*CancelPatchJobRequest) Descriptor
func (*CancelPatchJobRequest) Descriptor() ([]byte, []int)Deprecated: Use CancelPatchJobRequest.ProtoReflect.Descriptor instead.
func (*CancelPatchJobRequest) GetName
func (x *CancelPatchJobRequest) GetName() stringfunc (*CancelPatchJobRequest) ProtoMessage
func (*CancelPatchJobRequest) ProtoMessage()func (*CancelPatchJobRequest) ProtoReflect
func (x *CancelPatchJobRequest) ProtoReflect() protoreflect.Messagefunc (*CancelPatchJobRequest) Reset
func (x *CancelPatchJobRequest) Reset()func (*CancelPatchJobRequest) String
func (x *CancelPatchJobRequest) String() stringCreateGuestPolicyRequest
type CreateGuestPolicyRequest struct {
// Required. The resource name of the parent using one of the following forms:
// `projects/{project_number}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
GuestPolicyId string `protobuf:"bytes,2,opt,name=guest_policy_id,json=guestPolicyId,proto3" json:"guest_policy_id,omitempty"`
// Required. The GuestPolicy to create.
GuestPolicy *GuestPolicy `protobuf:"bytes,3,opt,name=guest_policy,json=guestPolicy,proto3" json:"guest_policy,omitempty"`
// contains filtered or unexported fields
}A request message for creating a guest policy.
func (*CreateGuestPolicyRequest) Descriptor
func (*CreateGuestPolicyRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateGuestPolicyRequest.ProtoReflect.Descriptor instead.
func (*CreateGuestPolicyRequest) GetGuestPolicy
func (x *CreateGuestPolicyRequest) GetGuestPolicy() *GuestPolicyfunc (*CreateGuestPolicyRequest) GetGuestPolicyId
func (x *CreateGuestPolicyRequest) GetGuestPolicyId() stringfunc (*CreateGuestPolicyRequest) GetParent
func (x *CreateGuestPolicyRequest) GetParent() stringfunc (*CreateGuestPolicyRequest) ProtoMessage
func (*CreateGuestPolicyRequest) ProtoMessage()func (*CreateGuestPolicyRequest) ProtoReflect
func (x *CreateGuestPolicyRequest) ProtoReflect() protoreflect.Messagefunc (*CreateGuestPolicyRequest) Reset
func (x *CreateGuestPolicyRequest) Reset()func (*CreateGuestPolicyRequest) String
func (x *CreateGuestPolicyRequest) String() stringCreatePatchDeploymentRequest
type CreatePatchDeploymentRequest struct {
// Required. The project to apply this patch deployment to in the form `projects/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
PatchDeploymentId string `protobuf:"bytes,2,opt,name=patch_deployment_id,json=patchDeploymentId,proto3" json:"patch_deployment_id,omitempty"`
// Required. The patch deployment to create.
PatchDeployment *PatchDeployment `protobuf:"bytes,3,opt,name=patch_deployment,json=patchDeployment,proto3" json:"patch_deployment,omitempty"`
// contains filtered or unexported fields
}A request message for creating a patch deployment.
func (*CreatePatchDeploymentRequest) Descriptor
func (*CreatePatchDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use CreatePatchDeploymentRequest.ProtoReflect.Descriptor instead.
func (*CreatePatchDeploymentRequest) GetParent
func (x *CreatePatchDeploymentRequest) GetParent() stringfunc (*CreatePatchDeploymentRequest) GetPatchDeployment
func (x *CreatePatchDeploymentRequest) GetPatchDeployment() *PatchDeploymentfunc (*CreatePatchDeploymentRequest) GetPatchDeploymentId
func (x *CreatePatchDeploymentRequest) GetPatchDeploymentId() stringfunc (*CreatePatchDeploymentRequest) ProtoMessage
func (*CreatePatchDeploymentRequest) ProtoMessage()func (*CreatePatchDeploymentRequest) ProtoReflect
func (x *CreatePatchDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*CreatePatchDeploymentRequest) Reset
func (x *CreatePatchDeploymentRequest) Reset()func (*CreatePatchDeploymentRequest) String
func (x *CreatePatchDeploymentRequest) String() stringDeleteGuestPolicyRequest
type DeleteGuestPolicyRequest struct {
// Required. The resource name of the guest policy using one of the following forms:
// `projects/{project_number}/guestPolicies/{guest_policy_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A request message for deleting a guest policy.
func (*DeleteGuestPolicyRequest) Descriptor
func (*DeleteGuestPolicyRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteGuestPolicyRequest.ProtoReflect.Descriptor instead.
func (*DeleteGuestPolicyRequest) GetName
func (x *DeleteGuestPolicyRequest) GetName() stringfunc (*DeleteGuestPolicyRequest) ProtoMessage
func (*DeleteGuestPolicyRequest) ProtoMessage()func (*DeleteGuestPolicyRequest) ProtoReflect
func (x *DeleteGuestPolicyRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteGuestPolicyRequest) Reset
func (x *DeleteGuestPolicyRequest) Reset()func (*DeleteGuestPolicyRequest) String
func (x *DeleteGuestPolicyRequest) String() stringDeletePatchDeploymentRequest
type DeletePatchDeploymentRequest struct {
// Required. The resource name of the patch deployment in the form
// `projects/*/patchDeployments/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A request message for deleting a patch deployment.
func (*DeletePatchDeploymentRequest) Descriptor
func (*DeletePatchDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use DeletePatchDeploymentRequest.ProtoReflect.Descriptor instead.
func (*DeletePatchDeploymentRequest) GetName
func (x *DeletePatchDeploymentRequest) GetName() stringfunc (*DeletePatchDeploymentRequest) ProtoMessage
func (*DeletePatchDeploymentRequest) ProtoMessage()func (*DeletePatchDeploymentRequest) ProtoReflect
func (x *DeletePatchDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*DeletePatchDeploymentRequest) Reset
func (x *DeletePatchDeploymentRequest) Reset()func (*DeletePatchDeploymentRequest) String
func (x *DeletePatchDeploymentRequest) String() stringDesiredState
type DesiredState int32The desired state that the OS Config agent maintains on the VM instance.
DesiredState_DESIRED_STATE_UNSPECIFIED, DesiredState_INSTALLED, DesiredState_UPDATED, DesiredState_REMOVED
const (
// The default is to ensure the package is installed.
DesiredState_DESIRED_STATE_UNSPECIFIED DesiredState = 0
// The agent ensures that the package is installed.
DesiredState_INSTALLED DesiredState = 1
// The agent ensures that the package is installed and
// periodically checks for and install any updates.
DesiredState_UPDATED DesiredState = 2
// The agent ensures that the package is not installed and uninstall it
// if detected.
DesiredState_REMOVED DesiredState = 3
)func (DesiredState) Descriptor
func (DesiredState) Descriptor() protoreflect.EnumDescriptorfunc (DesiredState) Enum
func (x DesiredState) Enum() *DesiredStatefunc (DesiredState) EnumDescriptor
func (DesiredState) EnumDescriptor() ([]byte, []int)Deprecated: Use DesiredState.Descriptor instead.
func (DesiredState) Number
func (x DesiredState) Number() protoreflect.EnumNumberfunc (DesiredState) String
func (x DesiredState) String() stringfunc (DesiredState) Type
func (DesiredState) Type() protoreflect.EnumTypeEffectiveGuestPolicy
type EffectiveGuestPolicy struct {
// List of package configurations assigned to the VM instance.
Packages []*EffectiveGuestPolicy_SourcedPackage `protobuf:"bytes,1,rep,name=packages,proto3" json:"packages,omitempty"`
// List of package repository configurations assigned to the VM instance.
PackageRepositories []*EffectiveGuestPolicy_SourcedPackageRepository `protobuf:"bytes,2,rep,name=package_repositories,json=packageRepositories,proto3" json:"package_repositories,omitempty"`
// List of recipes assigned to the VM instance.
SoftwareRecipes []*EffectiveGuestPolicy_SourcedSoftwareRecipe `protobuf:"bytes,3,rep,name=software_recipes,json=softwareRecipes,proto3" json:"software_recipes,omitempty"`
// contains filtered or unexported fields
}The effective guest policy that applies to a VM instance.
func (*EffectiveGuestPolicy) Descriptor
func (*EffectiveGuestPolicy) Descriptor() ([]byte, []int)Deprecated: Use EffectiveGuestPolicy.ProtoReflect.Descriptor instead.
func (*EffectiveGuestPolicy) GetPackageRepositories
func (x *EffectiveGuestPolicy) GetPackageRepositories() []*EffectiveGuestPolicy_SourcedPackageRepositoryfunc (*EffectiveGuestPolicy) GetPackages
func (x *EffectiveGuestPolicy) GetPackages() []*EffectiveGuestPolicy_SourcedPackagefunc (*EffectiveGuestPolicy) GetSoftwareRecipes
func (x *EffectiveGuestPolicy) GetSoftwareRecipes() []*EffectiveGuestPolicy_SourcedSoftwareRecipefunc (*EffectiveGuestPolicy) ProtoMessage
func (*EffectiveGuestPolicy) ProtoMessage()func (*EffectiveGuestPolicy) ProtoReflect
func (x *EffectiveGuestPolicy) ProtoReflect() protoreflect.Messagefunc (*EffectiveGuestPolicy) Reset
func (x *EffectiveGuestPolicy) Reset()func (*EffectiveGuestPolicy) String
func (x *EffectiveGuestPolicy) String() stringEffectiveGuestPolicy_SourcedPackage
type EffectiveGuestPolicy_SourcedPackage struct {
// Name of the guest policy providing this config.
Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
// A software package to configure on the VM instance.
Package *Package `protobuf:"bytes,2,opt,name=package,proto3" json:"package,omitempty"`
// contains filtered or unexported fields
}A guest policy package including its source.
func (*EffectiveGuestPolicy_SourcedPackage) Descriptor
func (*EffectiveGuestPolicy_SourcedPackage) Descriptor() ([]byte, []int)Deprecated: Use EffectiveGuestPolicy_SourcedPackage.ProtoReflect.Descriptor instead.
func (*EffectiveGuestPolicy_SourcedPackage) GetPackage
func (x *EffectiveGuestPolicy_SourcedPackage) GetPackage() *Packagefunc (*EffectiveGuestPolicy_SourcedPackage) GetSource
func (x *EffectiveGuestPolicy_SourcedPackage) GetSource() stringfunc (*EffectiveGuestPolicy_SourcedPackage) ProtoMessage
func (*EffectiveGuestPolicy_SourcedPackage) ProtoMessage()func (*EffectiveGuestPolicy_SourcedPackage) ProtoReflect
func (x *EffectiveGuestPolicy_SourcedPackage) ProtoReflect() protoreflect.Messagefunc (*EffectiveGuestPolicy_SourcedPackage) Reset
func (x *EffectiveGuestPolicy_SourcedPackage) Reset()func (*EffectiveGuestPolicy_SourcedPackage) String
func (x *EffectiveGuestPolicy_SourcedPackage) String() stringEffectiveGuestPolicy_SourcedPackageRepository
type EffectiveGuestPolicy_SourcedPackageRepository struct {
// Name of the guest policy providing this config.
Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
// A software package repository to configure on the VM instance.
PackageRepository *PackageRepository `protobuf:"bytes,2,opt,name=package_repository,json=packageRepository,proto3" json:"package_repository,omitempty"`
// contains filtered or unexported fields
}A guest policy package repository including its source.
func (*EffectiveGuestPolicy_SourcedPackageRepository) Descriptor
func (*EffectiveGuestPolicy_SourcedPackageRepository) Descriptor() ([]byte, []int)Deprecated: Use EffectiveGuestPolicy_SourcedPackageRepository.ProtoReflect.Descriptor instead.
func (*EffectiveGuestPolicy_SourcedPackageRepository) GetPackageRepository
func (x *EffectiveGuestPolicy_SourcedPackageRepository) GetPackageRepository() *PackageRepositoryfunc (*EffectiveGuestPolicy_SourcedPackageRepository) GetSource
func (x *EffectiveGuestPolicy_SourcedPackageRepository) GetSource() stringfunc (*EffectiveGuestPolicy_SourcedPackageRepository) ProtoMessage
func (*EffectiveGuestPolicy_SourcedPackageRepository) ProtoMessage()func (*EffectiveGuestPolicy_SourcedPackageRepository) ProtoReflect
func (x *EffectiveGuestPolicy_SourcedPackageRepository) ProtoReflect() protoreflect.Messagefunc (*EffectiveGuestPolicy_SourcedPackageRepository) Reset
func (x *EffectiveGuestPolicy_SourcedPackageRepository) Reset()func (*EffectiveGuestPolicy_SourcedPackageRepository) String
func (x *EffectiveGuestPolicy_SourcedPackageRepository) String() stringEffectiveGuestPolicy_SourcedSoftwareRecipe
type EffectiveGuestPolicy_SourcedSoftwareRecipe struct {
// Name of the guest policy providing this config.
Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
// A software recipe to configure on the VM instance.
SoftwareRecipe *SoftwareRecipe `protobuf:"bytes,2,opt,name=software_recipe,json=softwareRecipe,proto3" json:"software_recipe,omitempty"`
// contains filtered or unexported fields
}A guest policy recipe including its source.
func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) Descriptor
func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) Descriptor() ([]byte, []int)Deprecated: Use EffectiveGuestPolicy_SourcedSoftwareRecipe.ProtoReflect.Descriptor instead.
func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) GetSoftwareRecipe
func (x *EffectiveGuestPolicy_SourcedSoftwareRecipe) GetSoftwareRecipe() *SoftwareRecipefunc (*EffectiveGuestPolicy_SourcedSoftwareRecipe) GetSource
func (x *EffectiveGuestPolicy_SourcedSoftwareRecipe) GetSource() stringfunc (*EffectiveGuestPolicy_SourcedSoftwareRecipe) ProtoMessage
func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) ProtoMessage()func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) ProtoReflect
func (x *EffectiveGuestPolicy_SourcedSoftwareRecipe) ProtoReflect() protoreflect.Messagefunc (*EffectiveGuestPolicy_SourcedSoftwareRecipe) Reset
func (x *EffectiveGuestPolicy_SourcedSoftwareRecipe) Reset()func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) String
func (x *EffectiveGuestPolicy_SourcedSoftwareRecipe) String() stringExecStep
type ExecStep struct {
// The ExecStepConfig for all Linux VMs targeted by the PatchJob.
LinuxExecStepConfig *ExecStepConfig `protobuf:"bytes,1,opt,name=linux_exec_step_config,json=linuxExecStepConfig,proto3" json:"linux_exec_step_config,omitempty"`
// The ExecStepConfig for all Windows VMs targeted by the PatchJob.
WindowsExecStepConfig *ExecStepConfig `protobuf:"bytes,2,opt,name=windows_exec_step_config,json=windowsExecStepConfig,proto3" json:"windows_exec_step_config,omitempty"`
// contains filtered or unexported fields
}A step that runs an executable for a PatchJob.
func (*ExecStep) Descriptor
Deprecated: Use ExecStep.ProtoReflect.Descriptor instead.
func (*ExecStep) GetLinuxExecStepConfig
func (x *ExecStep) GetLinuxExecStepConfig() *ExecStepConfigfunc (*ExecStep) GetWindowsExecStepConfig
func (x *ExecStep) GetWindowsExecStepConfig() *ExecStepConfigfunc (*ExecStep) ProtoMessage
func (*ExecStep) ProtoMessage()func (*ExecStep) ProtoReflect
func (x *ExecStep) ProtoReflect() protoreflect.Messagefunc (*ExecStep) Reset
func (x *ExecStep) Reset()func (*ExecStep) String
ExecStepConfig
type ExecStepConfig struct {
// Location of the executable.
//
// Types that are assignable to Executable:
//
// *ExecStepConfig_LocalPath
// *ExecStepConfig_GcsObject
Executable isExecStepConfig_Executable `protobuf_oneof:"executable"`
// Defaults to [0]. A list of possible return values that the
// execution can return to indicate a success.
AllowedSuccessCodes []int32 `protobuf:"varint,3,rep,packed,name=allowed_success_codes,json=allowedSuccessCodes,proto3" json:"allowed_success_codes,omitempty"`
// 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\)).
Interpreter ExecStepConfig_Interpreter `protobuf:"varint,4,opt,name=interpreter,proto3,enum=google.cloud.osconfig.v1beta.ExecStepConfig_Interpreter" json:"interpreter,omitempty"`
// contains filtered or unexported fields
}Common configurations for an ExecStep.
func (*ExecStepConfig) Descriptor
func (*ExecStepConfig) Descriptor() ([]byte, []int)Deprecated: Use ExecStepConfig.ProtoReflect.Descriptor instead.
func (*ExecStepConfig) GetAllowedSuccessCodes
func (x *ExecStepConfig) GetAllowedSuccessCodes() []int32func (*ExecStepConfig) GetExecutable
func (m *ExecStepConfig) GetExecutable() isExecStepConfig_Executablefunc (*ExecStepConfig) GetGcsObject
func (x *ExecStepConfig) GetGcsObject() *GcsObjectfunc (*ExecStepConfig) GetInterpreter
func (x *ExecStepConfig) GetInterpreter() ExecStepConfig_Interpreterfunc (*ExecStepConfig) GetLocalPath
func (x *ExecStepConfig) GetLocalPath() stringfunc (*ExecStepConfig) ProtoMessage
func (*ExecStepConfig) ProtoMessage()func (*ExecStepConfig) ProtoReflect
func (x *ExecStepConfig) ProtoReflect() protoreflect.Messagefunc (*ExecStepConfig) Reset
func (x *ExecStepConfig) Reset()func (*ExecStepConfig) String
func (x *ExecStepConfig) String() stringExecStepConfig_GcsObject
type ExecStepConfig_GcsObject struct {
// A Google Cloud Storage object containing the executable.
GcsObject *GcsObject `protobuf:"bytes,2,opt,name=gcs_object,json=gcsObject,proto3,oneof"`
}ExecStepConfig_Interpreter
type ExecStepConfig_Interpreter int32The interpreter used to execute the a file.
ExecStepConfig_INTERPRETER_UNSPECIFIED, ExecStepConfig_SHELL, ExecStepConfig_POWERSHELL
const (
// Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
// interpreter will be parsed from the shebang line of the script if
// unspecified.
ExecStepConfig_INTERPRETER_UNSPECIFIED ExecStepConfig_Interpreter = 0
// Indicates that the script is run with `/bin/sh` on Linux and `cmd`
// on Windows.
ExecStepConfig_SHELL ExecStepConfig_Interpreter = 1
// Indicates that the file is run with PowerShell flags
// `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`.
ExecStepConfig_POWERSHELL ExecStepConfig_Interpreter = 2
)func (ExecStepConfig_Interpreter) Descriptor
func (ExecStepConfig_Interpreter) Descriptor() protoreflect.EnumDescriptorfunc (ExecStepConfig_Interpreter) Enum
func (x ExecStepConfig_Interpreter) Enum() *ExecStepConfig_Interpreterfunc (ExecStepConfig_Interpreter) EnumDescriptor
func (ExecStepConfig_Interpreter) EnumDescriptor() ([]byte, []int)Deprecated: Use ExecStepConfig_Interpreter.Descriptor instead.
func (ExecStepConfig_Interpreter) Number
func (x ExecStepConfig_Interpreter) Number() protoreflect.EnumNumberfunc (ExecStepConfig_Interpreter) String
func (x ExecStepConfig_Interpreter) String() stringfunc (ExecStepConfig_Interpreter) Type
func (ExecStepConfig_Interpreter) Type() protoreflect.EnumTypeExecStepConfig_LocalPath
type ExecStepConfig_LocalPath struct {
// An absolute path to the executable on the VM.
LocalPath string `protobuf:"bytes,1,opt,name=local_path,json=localPath,proto3,oneof"`
}ExecutePatchJobRequest
type ExecutePatchJobRequest struct {
// Required. The project in which to run this patch in the form `projects/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Description of the patch job. Length of the description is limited
// to 1024 characters.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Required. Instances to patch, either explicitly or filtered by some criteria such
// as zone or labels.
InstanceFilter *PatchInstanceFilter `protobuf:"bytes,7,opt,name=instance_filter,json=instanceFilter,proto3" json:"instance_filter,omitempty"`
// Patch configuration being applied. If omitted, instances are
// patched using the default configurations.
PatchConfig *PatchConfig `protobuf:"bytes,4,opt,name=patch_config,json=patchConfig,proto3" json:"patch_config,omitempty"`
// Duration of the patch job. After the duration ends, the patch job
// times out.
Duration *durationpb.Duration `protobuf:"bytes,5,opt,name=duration,proto3" json:"duration,omitempty"`
// If this patch is a dry-run only, instances are contacted but
// will do nothing.
DryRun bool `protobuf:"varint,6,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
// Display name for this patch job. This does not have to be unique.
DisplayName string `protobuf:"bytes,8,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Rollout strategy of the patch job.
Rollout *PatchRollout `protobuf:"bytes,9,opt,name=rollout,proto3" json:"rollout,omitempty"`
// contains filtered or unexported fields
}A request message to initiate patching across Compute Engine instances.
func (*ExecutePatchJobRequest) Descriptor
func (*ExecutePatchJobRequest) Descriptor() ([]byte, []int)Deprecated: Use ExecutePatchJobRequest.ProtoReflect.Descriptor instead.
func (*ExecutePatchJobRequest) GetDescription
func (x *ExecutePatchJobRequest) GetDescription() stringfunc (*ExecutePatchJobRequest) GetDisplayName
func (x *ExecutePatchJobRequest) GetDisplayName() stringfunc (*ExecutePatchJobRequest) GetDryRun
func (x *ExecutePatchJobRequest) GetDryRun() boolfunc (*ExecutePatchJobRequest) GetDuration
func (x *ExecutePatchJobRequest) GetDuration() *durationpb.Durationfunc (*ExecutePatchJobRequest) GetInstanceFilter
func (x *ExecutePatchJobRequest) GetInstanceFilter() *PatchInstanceFilterfunc (*ExecutePatchJobRequest) GetParent
func (x *ExecutePatchJobRequest) GetParent() stringfunc (*ExecutePatchJobRequest) GetPatchConfig
func (x *ExecutePatchJobRequest) GetPatchConfig() *PatchConfigfunc (*ExecutePatchJobRequest) GetRollout
func (x *ExecutePatchJobRequest) GetRollout() *PatchRolloutfunc (*ExecutePatchJobRequest) ProtoMessage
func (*ExecutePatchJobRequest) ProtoMessage()func (*ExecutePatchJobRequest) ProtoReflect
func (x *ExecutePatchJobRequest) ProtoReflect() protoreflect.Messagefunc (*ExecutePatchJobRequest) Reset
func (x *ExecutePatchJobRequest) Reset()func (*ExecutePatchJobRequest) String
func (x *ExecutePatchJobRequest) String() stringFixedOrPercent
type FixedOrPercent struct {
// Type of the value.
//
// Types that are assignable to Mode:
//
// *FixedOrPercent_Fixed
// *FixedOrPercent_Percent
Mode isFixedOrPercent_Mode `protobuf_oneof:"mode"`
// contains filtered or unexported fields
}Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
func (*FixedOrPercent) Descriptor
func (*FixedOrPercent) Descriptor() ([]byte, []int)Deprecated: Use FixedOrPercent.ProtoReflect.Descriptor instead.
func (*FixedOrPercent) GetFixed
func (x *FixedOrPercent) GetFixed() int32func (*FixedOrPercent) GetMode
func (m *FixedOrPercent) GetMode() isFixedOrPercent_Modefunc (*FixedOrPercent) GetPercent
func (x *FixedOrPercent) GetPercent() int32func (*FixedOrPercent) ProtoMessage
func (*FixedOrPercent) ProtoMessage()func (*FixedOrPercent) ProtoReflect
func (x *FixedOrPercent) ProtoReflect() protoreflect.Messagefunc (*FixedOrPercent) Reset
func (x *FixedOrPercent) Reset()func (*FixedOrPercent) String
func (x *FixedOrPercent) String() stringFixedOrPercent_Fixed
type FixedOrPercent_Fixed struct {
// Specifies a fixed value.
Fixed int32 `protobuf:"varint,1,opt,name=fixed,proto3,oneof"`
}FixedOrPercent_Percent
type FixedOrPercent_Percent struct {
// Specifies the relative value defined as a percentage, which will be
// multiplied by a reference value.
Percent int32 `protobuf:"varint,2,opt,name=percent,proto3,oneof"`
}GcsObject
type GcsObject struct {
// Required. Bucket of the Google Cloud Storage object.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. Name of the Google Cloud Storage object.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// 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 `protobuf:"varint,3,opt,name=generation_number,json=generationNumber,proto3" json:"generation_number,omitempty"`
// contains filtered or unexported fields
}Google Cloud Storage object representation.
func (*GcsObject) Descriptor
Deprecated: Use GcsObject.ProtoReflect.Descriptor instead.
func (*GcsObject) GetBucket
func (*GcsObject) GetGenerationNumber
func (*GcsObject) GetObject
func (*GcsObject) ProtoMessage
func (*GcsObject) ProtoMessage()func (*GcsObject) ProtoReflect
func (x *GcsObject) ProtoReflect() protoreflect.Messagefunc (*GcsObject) Reset
func (x *GcsObject) Reset()func (*GcsObject) String
GetGuestPolicyRequest
type GetGuestPolicyRequest struct {
// Required. The resource name of the guest policy using one of the following forms:
// `projects/{project_number}/guestPolicies/{guest_policy_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A request message for retrieving a guest policy.
func (*GetGuestPolicyRequest) Descriptor
func (*GetGuestPolicyRequest) Descriptor() ([]byte, []int)Deprecated: Use GetGuestPolicyRequest.ProtoReflect.Descriptor instead.
func (*GetGuestPolicyRequest) GetName
func (x *GetGuestPolicyRequest) GetName() stringfunc (*GetGuestPolicyRequest) ProtoMessage
func (*GetGuestPolicyRequest) ProtoMessage()func (*GetGuestPolicyRequest) ProtoReflect
func (x *GetGuestPolicyRequest) ProtoReflect() protoreflect.Messagefunc (*GetGuestPolicyRequest) Reset
func (x *GetGuestPolicyRequest) Reset()func (*GetGuestPolicyRequest) String
func (x *GetGuestPolicyRequest) String() stringGetPatchDeploymentRequest
type GetPatchDeploymentRequest struct {
// Required. The resource name of the patch deployment in the form
// `projects/*/patchDeployments/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A request message for retrieving a patch deployment.
func (*GetPatchDeploymentRequest) Descriptor
func (*GetPatchDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use GetPatchDeploymentRequest.ProtoReflect.Descriptor instead.
func (*GetPatchDeploymentRequest) GetName
func (x *GetPatchDeploymentRequest) GetName() stringfunc (*GetPatchDeploymentRequest) ProtoMessage
func (*GetPatchDeploymentRequest) ProtoMessage()func (*GetPatchDeploymentRequest) ProtoReflect
func (x *GetPatchDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*GetPatchDeploymentRequest) Reset
func (x *GetPatchDeploymentRequest) Reset()func (*GetPatchDeploymentRequest) String
func (x *GetPatchDeploymentRequest) String() stringGetPatchJobRequest
type GetPatchJobRequest struct {
// Required. Name of the patch in the form `projects/*/patchJobs/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request to get an active or completed patch job.
func (*GetPatchJobRequest) Descriptor
func (*GetPatchJobRequest) Descriptor() ([]byte, []int)Deprecated: Use GetPatchJobRequest.ProtoReflect.Descriptor instead.
func (*GetPatchJobRequest) GetName
func (x *GetPatchJobRequest) GetName() stringfunc (*GetPatchJobRequest) ProtoMessage
func (*GetPatchJobRequest) ProtoMessage()func (*GetPatchJobRequest) ProtoReflect
func (x *GetPatchJobRequest) ProtoReflect() protoreflect.Messagefunc (*GetPatchJobRequest) Reset
func (x *GetPatchJobRequest) Reset()func (*GetPatchJobRequest) String
func (x *GetPatchJobRequest) String() stringGooRepository
type GooRepository struct {
// Required. The name of the repository.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The url of the repository.
Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*GooRepository) Descriptor() ([]byte, []int)Deprecated: Use GooRepository.ProtoReflect.Descriptor instead.
func (*GooRepository) GetName
func (x *GooRepository) GetName() stringfunc (*GooRepository) GetUrl
func (x *GooRepository) GetUrl() stringfunc (*GooRepository) ProtoMessage
func (*GooRepository) ProtoMessage()func (*GooRepository) ProtoReflect
func (x *GooRepository) ProtoReflect() protoreflect.Messagefunc (*GooRepository) Reset
func (x *GooRepository) Reset()func (*GooRepository) String
func (x *GooRepository) String() stringGooSettings
type GooSettings struct {
// contains filtered or unexported fields
}Googet patching is performed by running googet update.
func (*GooSettings) Descriptor
func (*GooSettings) Descriptor() ([]byte, []int)Deprecated: Use GooSettings.ProtoReflect.Descriptor instead.
func (*GooSettings) ProtoMessage
func (*GooSettings) ProtoMessage()func (*GooSettings) ProtoReflect
func (x *GooSettings) ProtoReflect() protoreflect.Messagefunc (*GooSettings) Reset
func (x *GooSettings) Reset()func (*GooSettings) String
func (x *GooSettings) String() stringGuestPolicy
type GuestPolicy struct {
// Required. Unique name of the resource in this project using one of the following
// forms:
// `projects/{project_number}/guestPolicies/{guest_policy_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Description of the guest policy. Length of the description is limited
// to 1024 characters.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Time this guest policy was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Last time this guest policy was updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// 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 `protobuf:"bytes,6,opt,name=assignment,proto3" json:"assignment,omitempty"`
// The software packages to be managed by this policy.
Packages []*Package `protobuf:"bytes,7,rep,name=packages,proto3" json:"packages,omitempty"`
// 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 `protobuf:"bytes,8,rep,name=package_repositories,json=packageRepositories,proto3" json:"package_repositories,omitempty"`
// A list of Recipes to install on the VM instance.
Recipes []*SoftwareRecipe `protobuf:"bytes,9,rep,name=recipes,proto3" json:"recipes,omitempty"`
// The etag for this guest policy.
// If this is provided on update, it must match the server's etag.
Etag string `protobuf:"bytes,10,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*GuestPolicy) Descriptor() ([]byte, []int)Deprecated: Use GuestPolicy.ProtoReflect.Descriptor instead.
func (*GuestPolicy) GetAssignment
func (x *GuestPolicy) GetAssignment() *Assignmentfunc (*GuestPolicy) GetCreateTime
func (x *GuestPolicy) GetCreateTime() *timestamppb.Timestampfunc (*GuestPolicy) GetDescription
func (x *GuestPolicy) GetDescription() stringfunc (*GuestPolicy) GetEtag
func (x *GuestPolicy) GetEtag() stringfunc (*GuestPolicy) GetName
func (x *GuestPolicy) GetName() stringfunc (*GuestPolicy) GetPackageRepositories
func (x *GuestPolicy) GetPackageRepositories() []*PackageRepositoryfunc (*GuestPolicy) GetPackages
func (x *GuestPolicy) GetPackages() []*Packagefunc (*GuestPolicy) GetRecipes
func (x *GuestPolicy) GetRecipes() []*SoftwareRecipefunc (*GuestPolicy) GetUpdateTime
func (x *GuestPolicy) GetUpdateTime() *timestamppb.Timestampfunc (*GuestPolicy) ProtoMessage
func (*GuestPolicy) ProtoMessage()func (*GuestPolicy) ProtoReflect
func (x *GuestPolicy) ProtoReflect() protoreflect.Messagefunc (*GuestPolicy) Reset
func (x *GuestPolicy) Reset()func (*GuestPolicy) String
func (x *GuestPolicy) String() stringInstance
type Instance struct {
// contains filtered or unexported fields
}Namespace for instance state enums.
func (*Instance) Descriptor
Deprecated: Use Instance.ProtoReflect.Descriptor instead.
func (*Instance) ProtoMessage
func (*Instance) ProtoMessage()func (*Instance) ProtoReflect
func (x *Instance) ProtoReflect() protoreflect.Messagefunc (*Instance) Reset
func (x *Instance) Reset()func (*Instance) String
Instance_PatchState
type Instance_PatchState int32Patch state of an instance.
Instance_PATCH_STATE_UNSPECIFIED, Instance_PENDING, Instance_INACTIVE, Instance_NOTIFIED, Instance_STARTED, Instance_DOWNLOADING_PATCHES, Instance_APPLYING_PATCHES, Instance_REBOOTING, Instance_SUCCEEDED, Instance_SUCCEEDED_REBOOT_REQUIRED, Instance_FAILED, Instance_ACKED, Instance_TIMED_OUT, Instance_RUNNING_PRE_PATCH_STEP, Instance_RUNNING_POST_PATCH_STEP, Instance_NO_AGENT_DETECTED
const (
// Unspecified.
Instance_PATCH_STATE_UNSPECIFIED Instance_PatchState = 0
// The instance is not yet notified.
Instance_PENDING Instance_PatchState = 1
// Instance is inactive and cannot be patched.
Instance_INACTIVE Instance_PatchState = 2
// The instance is notified that it should be patched.
Instance_NOTIFIED Instance_PatchState = 3
// The instance has started the patching process.
Instance_STARTED Instance_PatchState = 4
// The instance is downloading patches.
Instance_DOWNLOADING_PATCHES Instance_PatchState = 5
// The instance is applying patches.
Instance_APPLYING_PATCHES Instance_PatchState = 6
// The instance is rebooting.
Instance_REBOOTING Instance_PatchState = 7
// The instance has completed applying patches.
Instance_SUCCEEDED Instance_PatchState = 8
// The instance has completed applying patches but a reboot is required.
Instance_SUCCEEDED_REBOOT_REQUIRED Instance_PatchState = 9
// The instance has failed to apply the patch.
Instance_FAILED Instance_PatchState = 10
// The instance acked the notification and will start shortly.
Instance_ACKED Instance_PatchState = 11
// The instance exceeded the time out while applying the patch.
Instance_TIMED_OUT Instance_PatchState = 12
// The instance is running the pre-patch step.
Instance_RUNNING_PRE_PATCH_STEP Instance_PatchState = 13
// The instance is running the post-patch step.
Instance_RUNNING_POST_PATCH_STEP Instance_PatchState = 14
// 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.
Instance_NO_AGENT_DETECTED Instance_PatchState = 15
)func (Instance_PatchState) Descriptor
func (Instance_PatchState) Descriptor() protoreflect.EnumDescriptorfunc (Instance_PatchState) Enum
func (x Instance_PatchState) Enum() *Instance_PatchStatefunc (Instance_PatchState) EnumDescriptor
func (Instance_PatchState) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_PatchState.Descriptor instead.
func (Instance_PatchState) Number
func (x Instance_PatchState) Number() protoreflect.EnumNumberfunc (Instance_PatchState) String
func (x Instance_PatchState) String() stringfunc (Instance_PatchState) Type
func (Instance_PatchState) Type() protoreflect.EnumTypeListGuestPoliciesRequest
type ListGuestPoliciesRequest struct {
// Required. The resource name of the parent using one of the following forms:
// `projects/{project_number}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of guest policies to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A pagination token returned from a previous call to `ListGuestPolicies`
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}A request message for listing guest policies.
func (*ListGuestPoliciesRequest) Descriptor
func (*ListGuestPoliciesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListGuestPoliciesRequest.ProtoReflect.Descriptor instead.
func (*ListGuestPoliciesRequest) GetPageSize
func (x *ListGuestPoliciesRequest) GetPageSize() int32func (*ListGuestPoliciesRequest) GetPageToken
func (x *ListGuestPoliciesRequest) GetPageToken() stringfunc (*ListGuestPoliciesRequest) GetParent
func (x *ListGuestPoliciesRequest) GetParent() stringfunc (*ListGuestPoliciesRequest) ProtoMessage
func (*ListGuestPoliciesRequest) ProtoMessage()func (*ListGuestPoliciesRequest) ProtoReflect
func (x *ListGuestPoliciesRequest) ProtoReflect() protoreflect.Messagefunc (*ListGuestPoliciesRequest) Reset
func (x *ListGuestPoliciesRequest) Reset()func (*ListGuestPoliciesRequest) String
func (x *ListGuestPoliciesRequest) String() stringListGuestPoliciesResponse
type ListGuestPoliciesResponse struct {
// The list of GuestPolicies.
GuestPolicies []*GuestPolicy `protobuf:"bytes,1,rep,name=guest_policies,json=guestPolicies,proto3" json:"guest_policies,omitempty"`
// A pagination token that can be used to get the next page
// of guest policies.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}A response message for listing guest policies.
func (*ListGuestPoliciesResponse) Descriptor
func (*ListGuestPoliciesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListGuestPoliciesResponse.ProtoReflect.Descriptor instead.
func (*ListGuestPoliciesResponse) GetGuestPolicies
func (x *ListGuestPoliciesResponse) GetGuestPolicies() []*GuestPolicyfunc (*ListGuestPoliciesResponse) GetNextPageToken
func (x *ListGuestPoliciesResponse) GetNextPageToken() stringfunc (*ListGuestPoliciesResponse) ProtoMessage
func (*ListGuestPoliciesResponse) ProtoMessage()func (*ListGuestPoliciesResponse) ProtoReflect
func (x *ListGuestPoliciesResponse) ProtoReflect() protoreflect.Messagefunc (*ListGuestPoliciesResponse) Reset
func (x *ListGuestPoliciesResponse) Reset()func (*ListGuestPoliciesResponse) String
func (x *ListGuestPoliciesResponse) String() stringListPatchDeploymentsRequest
type ListPatchDeploymentsRequest struct {
// Required. The resource name of the parent in the form `projects/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of patch deployments to return. Default is 100.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A pagination token returned from a previous call to ListPatchDeployments
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}A request message for listing patch deployments.
func (*ListPatchDeploymentsRequest) Descriptor
func (*ListPatchDeploymentsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListPatchDeploymentsRequest.ProtoReflect.Descriptor instead.
func (*ListPatchDeploymentsRequest) GetPageSize
func (x *ListPatchDeploymentsRequest) GetPageSize() int32func (*ListPatchDeploymentsRequest) GetPageToken
func (x *ListPatchDeploymentsRequest) GetPageToken() stringfunc (*ListPatchDeploymentsRequest) GetParent
func (x *ListPatchDeploymentsRequest) GetParent() stringfunc (*ListPatchDeploymentsRequest) ProtoMessage
func (*ListPatchDeploymentsRequest) ProtoMessage()func (*ListPatchDeploymentsRequest) ProtoReflect
func (x *ListPatchDeploymentsRequest) ProtoReflect() protoreflect.Messagefunc (*ListPatchDeploymentsRequest) Reset
func (x *ListPatchDeploymentsRequest) Reset()func (*ListPatchDeploymentsRequest) String
func (x *ListPatchDeploymentsRequest) String() stringListPatchDeploymentsResponse
type ListPatchDeploymentsResponse struct {
// The list of patch deployments.
PatchDeployments []*PatchDeployment `protobuf:"bytes,1,rep,name=patch_deployments,json=patchDeployments,proto3" json:"patch_deployments,omitempty"`
// A pagination token that can be used to get the next page of patch
// deployments.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}A response message for listing patch deployments.
func (*ListPatchDeploymentsResponse) Descriptor
func (*ListPatchDeploymentsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListPatchDeploymentsResponse.ProtoReflect.Descriptor instead.
func (*ListPatchDeploymentsResponse) GetNextPageToken
func (x *ListPatchDeploymentsResponse) GetNextPageToken() stringfunc (*ListPatchDeploymentsResponse) GetPatchDeployments
func (x *ListPatchDeploymentsResponse) GetPatchDeployments() []*PatchDeploymentfunc (*ListPatchDeploymentsResponse) ProtoMessage
func (*ListPatchDeploymentsResponse) ProtoMessage()func (*ListPatchDeploymentsResponse) ProtoReflect
func (x *ListPatchDeploymentsResponse) ProtoReflect() protoreflect.Messagefunc (*ListPatchDeploymentsResponse) Reset
func (x *ListPatchDeploymentsResponse) Reset()func (*ListPatchDeploymentsResponse) String
func (x *ListPatchDeploymentsResponse) String() stringListPatchJobInstanceDetailsRequest
type ListPatchJobInstanceDetailsRequest struct {
// Required. The parent for the instances are in the form of `projects/*/patchJobs/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of instance details records to return. Default is 100.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A pagination token returned from a previous call
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A filter expression that filters results listed in the response. This
// field supports filtering results by instance zone, name, state, or
// `failure_reason`.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}Request to list details for all instances that are part of a patch job.
func (*ListPatchJobInstanceDetailsRequest) Descriptor
func (*ListPatchJobInstanceDetailsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListPatchJobInstanceDetailsRequest.ProtoReflect.Descriptor instead.
func (*ListPatchJobInstanceDetailsRequest) GetFilter
func (x *ListPatchJobInstanceDetailsRequest) GetFilter() stringfunc (*ListPatchJobInstanceDetailsRequest) GetPageSize
func (x *ListPatchJobInstanceDetailsRequest) GetPageSize() int32func (*ListPatchJobInstanceDetailsRequest) GetPageToken
func (x *ListPatchJobInstanceDetailsRequest) GetPageToken() stringfunc (*ListPatchJobInstanceDetailsRequest) GetParent
func (x *ListPatchJobInstanceDetailsRequest) GetParent() stringfunc (*ListPatchJobInstanceDetailsRequest) ProtoMessage
func (*ListPatchJobInstanceDetailsRequest) ProtoMessage()func (*ListPatchJobInstanceDetailsRequest) ProtoReflect
func (x *ListPatchJobInstanceDetailsRequest) ProtoReflect() protoreflect.Messagefunc (*ListPatchJobInstanceDetailsRequest) Reset
func (x *ListPatchJobInstanceDetailsRequest) Reset()func (*ListPatchJobInstanceDetailsRequest) String
func (x *ListPatchJobInstanceDetailsRequest) String() stringListPatchJobInstanceDetailsResponse
type ListPatchJobInstanceDetailsResponse struct {
// A list of instance status.
PatchJobInstanceDetails []*PatchJobInstanceDetails `protobuf:"bytes,1,rep,name=patch_job_instance_details,json=patchJobInstanceDetails,proto3" json:"patch_job_instance_details,omitempty"`
// A pagination token that can be used to get the next page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}A response message for listing the instances details for a patch job.
func (*ListPatchJobInstanceDetailsResponse) Descriptor
func (*ListPatchJobInstanceDetailsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListPatchJobInstanceDetailsResponse.ProtoReflect.Descriptor instead.
func (*ListPatchJobInstanceDetailsResponse) GetNextPageToken
func (x *ListPatchJobInstanceDetailsResponse) GetNextPageToken() stringfunc (*ListPatchJobInstanceDetailsResponse) GetPatchJobInstanceDetails
func (x *ListPatchJobInstanceDetailsResponse) GetPatchJobInstanceDetails() []*PatchJobInstanceDetailsfunc (*ListPatchJobInstanceDetailsResponse) ProtoMessage
func (*ListPatchJobInstanceDetailsResponse) ProtoMessage()func (*ListPatchJobInstanceDetailsResponse) ProtoReflect
func (x *ListPatchJobInstanceDetailsResponse) ProtoReflect() protoreflect.Messagefunc (*ListPatchJobInstanceDetailsResponse) Reset
func (x *ListPatchJobInstanceDetailsResponse) Reset()func (*ListPatchJobInstanceDetailsResponse) String
func (x *ListPatchJobInstanceDetailsResponse) String() stringListPatchJobsRequest
type ListPatchJobsRequest struct {
// Required. In the form of `projects/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of instance status to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A pagination token returned from a previous call
// that indicates where this listing should continue from.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// 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.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}A request message for listing patch jobs.
func (*ListPatchJobsRequest) Descriptor
func (*ListPatchJobsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListPatchJobsRequest.ProtoReflect.Descriptor instead.
func (*ListPatchJobsRequest) GetFilter
func (x *ListPatchJobsRequest) GetFilter() stringfunc (*ListPatchJobsRequest) GetPageSize
func (x *ListPatchJobsRequest) GetPageSize() int32func (*ListPatchJobsRequest) GetPageToken
func (x *ListPatchJobsRequest) GetPageToken() stringfunc (*ListPatchJobsRequest) GetParent
func (x *ListPatchJobsRequest) GetParent() stringfunc (*ListPatchJobsRequest) ProtoMessage
func (*ListPatchJobsRequest) ProtoMessage()func (*ListPatchJobsRequest) ProtoReflect
func (x *ListPatchJobsRequest) ProtoReflect() protoreflect.Messagefunc (*ListPatchJobsRequest) Reset
func (x *ListPatchJobsRequest) Reset()func (*ListPatchJobsRequest) String
func (x *ListPatchJobsRequest) String() stringListPatchJobsResponse
type ListPatchJobsResponse struct {
// The list of patch jobs.
PatchJobs []*PatchJob `protobuf:"bytes,1,rep,name=patch_jobs,json=patchJobs,proto3" json:"patch_jobs,omitempty"`
// A pagination token that can be used to get the next page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}A response message for listing patch jobs.
func (*ListPatchJobsResponse) Descriptor
func (*ListPatchJobsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListPatchJobsResponse.ProtoReflect.Descriptor instead.
func (*ListPatchJobsResponse) GetNextPageToken
func (x *ListPatchJobsResponse) GetNextPageToken() stringfunc (*ListPatchJobsResponse) GetPatchJobs
func (x *ListPatchJobsResponse) GetPatchJobs() []*PatchJobfunc (*ListPatchJobsResponse) ProtoMessage
func (*ListPatchJobsResponse) ProtoMessage()func (*ListPatchJobsResponse) ProtoReflect
func (x *ListPatchJobsResponse) ProtoReflect() protoreflect.Messagefunc (*ListPatchJobsResponse) Reset
func (x *ListPatchJobsResponse) Reset()func (*ListPatchJobsResponse) String
func (x *ListPatchJobsResponse) String() stringLookupEffectiveGuestPolicyRequest
type LookupEffectiveGuestPolicyRequest struct {
// Required. The VM instance whose policies are being looked up.
Instance string `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=os_short_name,json=osShortName,proto3" json:"os_short_name,omitempty"`
// 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 `protobuf:"bytes,3,opt,name=os_version,json=osVersion,proto3" json:"os_version,omitempty"`
// 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 `protobuf:"bytes,4,opt,name=os_architecture,json=osArchitecture,proto3" json:"os_architecture,omitempty"`
// contains filtered or unexported fields
}A request message for getting the effective guest policy assigned to the instance.
func (*LookupEffectiveGuestPolicyRequest) Descriptor
func (*LookupEffectiveGuestPolicyRequest) Descriptor() ([]byte, []int)Deprecated: Use LookupEffectiveGuestPolicyRequest.ProtoReflect.Descriptor instead.
func (*LookupEffectiveGuestPolicyRequest) GetInstance
func (x *LookupEffectiveGuestPolicyRequest) GetInstance() stringfunc (*LookupEffectiveGuestPolicyRequest) GetOsArchitecture
func (x *LookupEffectiveGuestPolicyRequest) GetOsArchitecture() stringfunc (*LookupEffectiveGuestPolicyRequest) GetOsShortName
func (x *LookupEffectiveGuestPolicyRequest) GetOsShortName() stringfunc (*LookupEffectiveGuestPolicyRequest) GetOsVersion
func (x *LookupEffectiveGuestPolicyRequest) GetOsVersion() stringfunc (*LookupEffectiveGuestPolicyRequest) ProtoMessage
func (*LookupEffectiveGuestPolicyRequest) ProtoMessage()func (*LookupEffectiveGuestPolicyRequest) ProtoReflect
func (x *LookupEffectiveGuestPolicyRequest) ProtoReflect() protoreflect.Messagefunc (*LookupEffectiveGuestPolicyRequest) Reset
func (x *LookupEffectiveGuestPolicyRequest) Reset()func (*LookupEffectiveGuestPolicyRequest) String
func (x *LookupEffectiveGuestPolicyRequest) String() stringMonthlySchedule
type MonthlySchedule struct {
// One day in a month.
//
// Types that are assignable to DayOfMonth:
//
// *MonthlySchedule_WeekDayOfMonth
// *MonthlySchedule_MonthDay
DayOfMonth isMonthlySchedule_DayOfMonth `protobuf_oneof:"day_of_month"`
// contains filtered or unexported fields
}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) Descriptor
func (*MonthlySchedule) Descriptor() ([]byte, []int)Deprecated: Use MonthlySchedule.ProtoReflect.Descriptor instead.
func (*MonthlySchedule) GetDayOfMonth
func (m *MonthlySchedule) GetDayOfMonth() isMonthlySchedule_DayOfMonthfunc (*MonthlySchedule) GetMonthDay
func (x *MonthlySchedule) GetMonthDay() int32func (*MonthlySchedule) GetWeekDayOfMonth
func (x *MonthlySchedule) GetWeekDayOfMonth() *WeekDayOfMonthfunc (*MonthlySchedule) ProtoMessage
func (*MonthlySchedule) ProtoMessage()func (*MonthlySchedule) ProtoReflect
func (x *MonthlySchedule) ProtoReflect() protoreflect.Messagefunc (*MonthlySchedule) Reset
func (x *MonthlySchedule) Reset()func (*MonthlySchedule) String
func (x *MonthlySchedule) String() stringMonthlySchedule_MonthDay
type MonthlySchedule_MonthDay struct {
// 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 int32 `protobuf:"varint,2,opt,name=month_day,json=monthDay,proto3,oneof"`
}MonthlySchedule_WeekDayOfMonth
type MonthlySchedule_WeekDayOfMonth struct {
// Required. Week day in a month.
WeekDayOfMonth *WeekDayOfMonth `protobuf:"bytes,1,opt,name=week_day_of_month,json=weekDayOfMonth,proto3,oneof"`
}OneTimeSchedule
type OneTimeSchedule struct {
// Required. The desired patch job execution time.
ExecuteTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=execute_time,json=executeTime,proto3" json:"execute_time,omitempty"`
// contains filtered or unexported fields
}Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.
func (*OneTimeSchedule) Descriptor
func (*OneTimeSchedule) Descriptor() ([]byte, []int)Deprecated: Use OneTimeSchedule.ProtoReflect.Descriptor instead.
func (*OneTimeSchedule) GetExecuteTime
func (x *OneTimeSchedule) GetExecuteTime() *timestamppb.Timestampfunc (*OneTimeSchedule) ProtoMessage
func (*OneTimeSchedule) ProtoMessage()func (*OneTimeSchedule) ProtoReflect
func (x *OneTimeSchedule) ProtoReflect() protoreflect.Messagefunc (*OneTimeSchedule) Reset
func (x *OneTimeSchedule) Reset()func (*OneTimeSchedule) String
func (x *OneTimeSchedule) String() stringOsConfigServiceClient
type OsConfigServiceClient interface {
// Patch VM instances by creating and running a patch job.
ExecutePatchJob(ctx context.Context, in *ExecutePatchJobRequest, opts ...grpc.CallOption) (*PatchJob, error)
// Get the patch job. This can be used to track the progress of an
// ongoing patch job or review the details of completed jobs.
GetPatchJob(ctx context.Context, in *GetPatchJobRequest, opts ...grpc.CallOption) (*PatchJob, error)
// Cancel a patch job. The patch job must be active. Canceled patch jobs
// cannot be restarted.
CancelPatchJob(ctx context.Context, in *CancelPatchJobRequest, opts ...grpc.CallOption) (*PatchJob, error)
// Get a list of patch jobs.
ListPatchJobs(ctx context.Context, in *ListPatchJobsRequest, opts ...grpc.CallOption) (*ListPatchJobsResponse, error)
// Get a list of instance details for a given patch job.
ListPatchJobInstanceDetails(ctx context.Context, in *ListPatchJobInstanceDetailsRequest, opts ...grpc.CallOption) (*ListPatchJobInstanceDetailsResponse, error)
// Create an OS Config patch deployment.
CreatePatchDeployment(ctx context.Context, in *CreatePatchDeploymentRequest, opts ...grpc.CallOption) (*PatchDeployment, error)
// Get an OS Config patch deployment.
GetPatchDeployment(ctx context.Context, in *GetPatchDeploymentRequest, opts ...grpc.CallOption) (*PatchDeployment, error)
// Get a page of OS Config patch deployments.
ListPatchDeployments(ctx context.Context, in *ListPatchDeploymentsRequest, opts ...grpc.CallOption) (*ListPatchDeploymentsResponse, error)
// Delete an OS Config patch deployment.
DeletePatchDeployment(ctx context.Context, in *DeletePatchDeploymentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Update an OS Config patch deployment.
UpdatePatchDeployment(ctx context.Context, in *UpdatePatchDeploymentRequest, opts ...grpc.CallOption) (*PatchDeployment, error)
// Change state of patch deployment to "PAUSED".
// Patch deployment in paused state doesn't generate patch jobs.
PausePatchDeployment(ctx context.Context, in *PausePatchDeploymentRequest, opts ...grpc.CallOption) (*PatchDeployment, error)
// Change state of patch deployment back to "ACTIVE".
// Patch deployment in active state continues to generate patch jobs.
ResumePatchDeployment(ctx context.Context, in *ResumePatchDeploymentRequest, opts ...grpc.CallOption) (*PatchDeployment, error)
// Create an OS Config guest policy.
CreateGuestPolicy(ctx context.Context, in *CreateGuestPolicyRequest, opts ...grpc.CallOption) (*GuestPolicy, error)
// Get an OS Config guest policy.
GetGuestPolicy(ctx context.Context, in *GetGuestPolicyRequest, opts ...grpc.CallOption) (*GuestPolicy, error)
// Get a page of OS Config guest policies.
ListGuestPolicies(ctx context.Context, in *ListGuestPoliciesRequest, opts ...grpc.CallOption) (*ListGuestPoliciesResponse, error)
// Update an OS Config guest policy.
UpdateGuestPolicy(ctx context.Context, in *UpdateGuestPolicyRequest, opts ...grpc.CallOption) (*GuestPolicy, error)
// Delete an OS Config guest policy.
DeleteGuestPolicy(ctx context.Context, in *DeleteGuestPolicyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lookup the effective guest policy that applies to a VM instance. This
// lookup merges all policies that are assigned to the instance ancestry.
LookupEffectiveGuestPolicy(ctx context.Context, in *LookupEffectiveGuestPolicyRequest, opts ...grpc.CallOption) (*EffectiveGuestPolicy, error)
}OsConfigServiceClient is the client API for OsConfigService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewOsConfigServiceClient
func NewOsConfigServiceClient(cc grpc.ClientConnInterface) OsConfigServiceClientOsConfigServiceServer
type OsConfigServiceServer interface {
// Patch VM instances by creating and running a patch job.
ExecutePatchJob(context.Context, *ExecutePatchJobRequest) (*PatchJob, error)
// Get the patch job. This can be used to track the progress of an
// ongoing patch job or review the details of completed jobs.
GetPatchJob(context.Context, *GetPatchJobRequest) (*PatchJob, error)
// Cancel a patch job. The patch job must be active. Canceled patch jobs
// cannot be restarted.
CancelPatchJob(context.Context, *CancelPatchJobRequest) (*PatchJob, error)
// Get a list of patch jobs.
ListPatchJobs(context.Context, *ListPatchJobsRequest) (*ListPatchJobsResponse, error)
// Get a list of instance details for a given patch job.
ListPatchJobInstanceDetails(context.Context, *ListPatchJobInstanceDetailsRequest) (*ListPatchJobInstanceDetailsResponse, error)
// Create an OS Config patch deployment.
CreatePatchDeployment(context.Context, *CreatePatchDeploymentRequest) (*PatchDeployment, error)
// Get an OS Config patch deployment.
GetPatchDeployment(context.Context, *GetPatchDeploymentRequest) (*PatchDeployment, error)
// Get a page of OS Config patch deployments.
ListPatchDeployments(context.Context, *ListPatchDeploymentsRequest) (*ListPatchDeploymentsResponse, error)
// Delete an OS Config patch deployment.
DeletePatchDeployment(context.Context, *DeletePatchDeploymentRequest) (*emptypb.Empty, error)
// Update an OS Config patch deployment.
UpdatePatchDeployment(context.Context, *UpdatePatchDeploymentRequest) (*PatchDeployment, error)
// Change state of patch deployment to "PAUSED".
// Patch deployment in paused state doesn't generate patch jobs.
PausePatchDeployment(context.Context, *PausePatchDeploymentRequest) (*PatchDeployment, error)
// Change state of patch deployment back to "ACTIVE".
// Patch deployment in active state continues to generate patch jobs.
ResumePatchDeployment(context.Context, *ResumePatchDeploymentRequest) (*PatchDeployment, error)
// Create an OS Config guest policy.
CreateGuestPolicy(context.Context, *CreateGuestPolicyRequest) (*GuestPolicy, error)
// Get an OS Config guest policy.
GetGuestPolicy(context.Context, *GetGuestPolicyRequest) (*GuestPolicy, error)
// Get a page of OS Config guest policies.
ListGuestPolicies(context.Context, *ListGuestPoliciesRequest) (*ListGuestPoliciesResponse, error)
// Update an OS Config guest policy.
UpdateGuestPolicy(context.Context, *UpdateGuestPolicyRequest) (*GuestPolicy, error)
// Delete an OS Config guest policy.
DeleteGuestPolicy(context.Context, *DeleteGuestPolicyRequest) (*emptypb.Empty, error)
// Lookup the effective guest policy that applies to a VM instance. This
// lookup merges all policies that are assigned to the instance ancestry.
LookupEffectiveGuestPolicy(context.Context, *LookupEffectiveGuestPolicyRequest) (*EffectiveGuestPolicy, error)
}OsConfigServiceServer is the server API for OsConfigService service. All implementations should embed UnimplementedOsConfigServiceServer for forward compatibility
Package
type Package struct {
// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The desired_state the agent should maintain for this package. The
// default is to ensure the package is installed.
DesiredState DesiredState `protobuf:"varint,2,opt,name=desired_state,json=desiredState,proto3,enum=google.cloud.osconfig.v1beta.DesiredState" json:"desired_state,omitempty"`
// 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.
Manager Package_Manager `protobuf:"varint,3,opt,name=manager,proto3,enum=google.cloud.osconfig.v1beta.Package_Manager" json:"manager,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
Deprecated: Use Package.ProtoReflect.Descriptor instead.
func (*Package) GetDesiredState
func (x *Package) GetDesiredState() DesiredStatefunc (*Package) GetManager
func (x *Package) GetManager() Package_Managerfunc (*Package) GetName
func (*Package) ProtoMessage
func (*Package) ProtoMessage()func (*Package) ProtoReflect
func (x *Package) ProtoReflect() protoreflect.Messagefunc (*Package) Reset
func (x *Package) Reset()func (*Package) String
PackageRepository
type PackageRepository struct {
// A specific type of repository.
//
// Types that are assignable to Repository:
//
// *PackageRepository_Apt
// *PackageRepository_Yum
// *PackageRepository_Zypper
// *PackageRepository_Goo
Repository isPackageRepository_Repository `protobuf_oneof:"repository"`
// contains filtered or unexported fields
}A package repository.
func (*PackageRepository) Descriptor
func (*PackageRepository) Descriptor() ([]byte, []int)Deprecated: Use PackageRepository.ProtoReflect.Descriptor instead.
func (*PackageRepository) GetApt
func (x *PackageRepository) GetApt() *AptRepositoryfunc (*PackageRepository) GetGoo
func (x *PackageRepository) GetGoo() *GooRepositoryfunc (*PackageRepository) GetRepository
func (m *PackageRepository) GetRepository() isPackageRepository_Repositoryfunc (*PackageRepository) GetYum
func (x *PackageRepository) GetYum() *YumRepositoryfunc (*PackageRepository) GetZypper
func (x *PackageRepository) GetZypper() *ZypperRepositoryfunc (*PackageRepository) ProtoMessage
func (*PackageRepository) ProtoMessage()func (*PackageRepository) ProtoReflect
func (x *PackageRepository) ProtoReflect() protoreflect.Messagefunc (*PackageRepository) Reset
func (x *PackageRepository) Reset()func (*PackageRepository) String
func (x *PackageRepository) String() stringPackageRepository_Apt
type PackageRepository_Apt struct {
// An Apt Repository.
Apt *AptRepository `protobuf:"bytes,1,opt,name=apt,proto3,oneof"`
}PackageRepository_Goo
type PackageRepository_Goo struct {
// A Goo Repository.
Goo *GooRepository `protobuf:"bytes,4,opt,name=goo,proto3,oneof"`
}PackageRepository_Yum
type PackageRepository_Yum struct {
// A Yum Repository.
Yum *YumRepository `protobuf:"bytes,2,opt,name=yum,proto3,oneof"`
}PackageRepository_Zypper
type PackageRepository_Zypper struct {
// A Zypper Repository.
Zypper *ZypperRepository `protobuf:"bytes,3,opt,name=zypper,proto3,oneof"`
}Package_Manager
type Package_Manager int32Types of package managers that may be used to manage this package.
Package_MANAGER_UNSPECIFIED, Package_ANY, Package_APT, Package_YUM, Package_ZYPPER, Package_GOO
const (
// The default behavior is ANY.
Package_MANAGER_UNSPECIFIED Package_Manager = 0
// Apply this package config using the default system package manager.
Package_ANY Package_Manager = 1
// Apply this package config only if Apt is available on the system.
Package_APT Package_Manager = 2
// Apply this package config only if Yum is available on the system.
Package_YUM Package_Manager = 3
// Apply this package config only if Zypper is available on the system.
Package_ZYPPER Package_Manager = 4
// Apply this package config only if GooGet is available on the system.
Package_GOO Package_Manager = 5
)func (Package_Manager) Descriptor
func (Package_Manager) Descriptor() protoreflect.EnumDescriptorfunc (Package_Manager) Enum
func (x Package_Manager) Enum() *Package_Managerfunc (Package_Manager) EnumDescriptor
func (Package_Manager) EnumDescriptor() ([]byte, []int)Deprecated: Use Package_Manager.Descriptor instead.
func (Package_Manager) Number
func (x Package_Manager) Number() protoreflect.EnumNumberfunc (Package_Manager) String
func (x Package_Manager) String() stringfunc (Package_Manager) Type
func (Package_Manager) Type() protoreflect.EnumTypePatchConfig
type PatchConfig struct {
// Post-patch reboot settings.
RebootConfig PatchConfig_RebootConfig `protobuf:"varint,1,opt,name=reboot_config,json=rebootConfig,proto3,enum=google.cloud.osconfig.v1beta.PatchConfig_RebootConfig" json:"reboot_config,omitempty"`
// Apt update settings. Use this setting to override the default `apt` patch
// rules.
Apt *AptSettings `protobuf:"bytes,3,opt,name=apt,proto3" json:"apt,omitempty"`
// Yum update settings. Use this setting to override the default `yum` patch
// rules.
Yum *YumSettings `protobuf:"bytes,4,opt,name=yum,proto3" json:"yum,omitempty"`
// Goo update settings. Use this setting to override the default `goo` patch
// rules.
Goo *GooSettings `protobuf:"bytes,5,opt,name=goo,proto3" json:"goo,omitempty"`
// Zypper update settings. Use this setting to override the default `zypper`
// patch rules.
Zypper *ZypperSettings `protobuf:"bytes,6,opt,name=zypper,proto3" json:"zypper,omitempty"`
// Windows update settings. Use this override the default windows patch rules.
WindowsUpdate *WindowsUpdateSettings `protobuf:"bytes,7,opt,name=windows_update,json=windowsUpdate,proto3" json:"windows_update,omitempty"`
// The `ExecStep` to run before the patch update.
PreStep *ExecStep `protobuf:"bytes,8,opt,name=pre_step,json=preStep,proto3" json:"pre_step,omitempty"`
// The `ExecStep` to run after the patch update.
PostStep *ExecStep `protobuf:"bytes,9,opt,name=post_step,json=postStep,proto3" json:"post_step,omitempty"`
// Allows the patch job to run on Managed instance groups (MIGs).
MigInstancesAllowed bool `protobuf:"varint,10,opt,name=mig_instances_allowed,json=migInstancesAllowed,proto3" json:"mig_instances_allowed,omitempty"`
// contains filtered or unexported fields
}Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.
func (*PatchConfig) Descriptor
func (*PatchConfig) Descriptor() ([]byte, []int)Deprecated: Use PatchConfig.ProtoReflect.Descriptor instead.
func (*PatchConfig) GetApt
func (x *PatchConfig) GetApt() *AptSettingsfunc (*PatchConfig) GetGoo
func (x *PatchConfig) GetGoo() *GooSettingsfunc (*PatchConfig) GetMigInstancesAllowed
func (x *PatchConfig) GetMigInstancesAllowed() boolfunc (*PatchConfig) GetPostStep
func (x *PatchConfig) GetPostStep() *ExecStepfunc (*PatchConfig) GetPreStep
func (x *PatchConfig) GetPreStep() *ExecStepfunc (*PatchConfig) GetRebootConfig
func (x *PatchConfig) GetRebootConfig() PatchConfig_RebootConfigfunc (*PatchConfig) GetWindowsUpdate
func (x *PatchConfig) GetWindowsUpdate() *WindowsUpdateSettingsfunc (*PatchConfig) GetYum
func (x *PatchConfig) GetYum() *YumSettingsfunc (*PatchConfig) GetZypper
func (x *PatchConfig) GetZypper() *ZypperSettingsfunc (*PatchConfig) ProtoMessage
func (*PatchConfig) ProtoMessage()func (*PatchConfig) ProtoReflect
func (x *PatchConfig) ProtoReflect() protoreflect.Messagefunc (*PatchConfig) Reset
func (x *PatchConfig) Reset()func (*PatchConfig) String
func (x *PatchConfig) String() stringPatchConfig_RebootConfig
type PatchConfig_RebootConfig int32Post-patch reboot settings.
PatchConfig_REBOOT_CONFIG_UNSPECIFIED, PatchConfig_DEFAULT, PatchConfig_ALWAYS, PatchConfig_NEVER
const (
// The default behavior is DEFAULT.
PatchConfig_REBOOT_CONFIG_UNSPECIFIED PatchConfig_RebootConfig = 0
// 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.
PatchConfig_DEFAULT PatchConfig_RebootConfig = 1
// Always reboot the machine after the update completes.
PatchConfig_ALWAYS PatchConfig_RebootConfig = 2
// Never reboot the machine after the update completes.
PatchConfig_NEVER PatchConfig_RebootConfig = 3
)func (PatchConfig_RebootConfig) Descriptor
func (PatchConfig_RebootConfig) Descriptor() protoreflect.EnumDescriptorfunc (PatchConfig_RebootConfig) Enum
func (x PatchConfig_RebootConfig) Enum() *PatchConfig_RebootConfigfunc (PatchConfig_RebootConfig) EnumDescriptor
func (PatchConfig_RebootConfig) EnumDescriptor() ([]byte, []int)Deprecated: Use PatchConfig_RebootConfig.Descriptor instead.
func (PatchConfig_RebootConfig) Number
func (x PatchConfig_RebootConfig) Number() protoreflect.EnumNumberfunc (PatchConfig_RebootConfig) String
func (x PatchConfig_RebootConfig) String() stringfunc (PatchConfig_RebootConfig) Type
func (PatchConfig_RebootConfig) Type() protoreflect.EnumTypePatchDeployment
type PatchDeployment struct {
// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Description of the patch deployment. Length of the description is limited
// to 1024 characters.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Required. VM instances to patch.
InstanceFilter *PatchInstanceFilter `protobuf:"bytes,3,opt,name=instance_filter,json=instanceFilter,proto3" json:"instance_filter,omitempty"`
// Optional. Patch configuration that is applied.
PatchConfig *PatchConfig `protobuf:"bytes,4,opt,name=patch_config,json=patchConfig,proto3" json:"patch_config,omitempty"`
// Optional. Duration of the patch. After the duration ends, the patch times out.
Duration *durationpb.Duration `protobuf:"bytes,5,opt,name=duration,proto3" json:"duration,omitempty"`
// Schedule for the patch.
//
// Types that are assignable to Schedule:
//
// *PatchDeployment_OneTimeSchedule
// *PatchDeployment_RecurringSchedule
Schedule isPatchDeployment_Schedule `protobuf_oneof:"schedule"`
// Output only. Time the patch deployment was created. Timestamp is in
// [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time the patch deployment was last updated. Timestamp is in
// [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// 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 *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=last_execute_time,json=lastExecuteTime,proto3" json:"last_execute_time,omitempty"`
// Optional. Rollout strategy of the patch job.
Rollout *PatchRollout `protobuf:"bytes,11,opt,name=rollout,proto3" json:"rollout,omitempty"`
// Output only. Current state of the patch deployment.
State PatchDeployment_State `protobuf:"varint,12,opt,name=state,proto3,enum=google.cloud.osconfig.v1beta.PatchDeployment_State" json:"state,omitempty"`
// contains filtered or unexported fields
}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.
func (*PatchDeployment) Descriptor
func (*PatchDeployment) Descriptor() ([]byte, []int)Deprecated: Use PatchDeployment.ProtoReflect.Descriptor instead.
func (*PatchDeployment) GetCreateTime
func (x *PatchDeployment) GetCreateTime() *timestamppb.Timestampfunc (*PatchDeployment) GetDescription
func (x *PatchDeployment) GetDescription() stringfunc (*PatchDeployment) GetDuration
func (x *PatchDeployment) GetDuration() *durationpb.Durationfunc (*PatchDeployment) GetInstanceFilter
func (x *PatchDeployment) GetInstanceFilter() *PatchInstanceFilterfunc (*PatchDeployment) GetLastExecuteTime
func (x *PatchDeployment) GetLastExecuteTime() *timestamppb.Timestampfunc (*PatchDeployment) GetName
func (x *PatchDeployment) GetName() stringfunc (*PatchDeployment) GetOneTimeSchedule
func (x *PatchDeployment) GetOneTimeSchedule() *OneTimeSchedulefunc (*PatchDeployment) GetPatchConfig
func (x *PatchDeployment) GetPatchConfig() *PatchConfigfunc (*PatchDeployment) GetRecurringSchedule
func (x *PatchDeployment) GetRecurringSchedule() *RecurringSchedulefunc (*PatchDeployment) GetRollout
func (x *PatchDeployment) GetRollout() *PatchRolloutfunc (*PatchDeployment) GetSchedule
func (m *PatchDeployment) GetSchedule() isPatchDeployment_Schedulefunc (*PatchDeployment) GetState
func (x *PatchDeployment) GetState() PatchDeployment_Statefunc (*PatchDeployment) GetUpdateTime
func (x *PatchDeployment) GetUpdateTime() *timestamppb.Timestampfunc (*PatchDeployment) ProtoMessage
func (*PatchDeployment) ProtoMessage()func (*PatchDeployment) ProtoReflect
func (x *PatchDeployment) ProtoReflect() protoreflect.Messagefunc (*PatchDeployment) Reset
func (x *PatchDeployment) Reset()func (*PatchDeployment) String
func (x *PatchDeployment) String() stringPatchDeployment_OneTimeSchedule
type PatchDeployment_OneTimeSchedule struct {
// Required. Schedule a one-time execution.
OneTimeSchedule *OneTimeSchedule `protobuf:"bytes,6,opt,name=one_time_schedule,json=oneTimeSchedule,proto3,oneof"`
}PatchDeployment_RecurringSchedule
type PatchDeployment_RecurringSchedule struct {
// Required. Schedule recurring executions.
RecurringSchedule *RecurringSchedule `protobuf:"bytes,7,opt,name=recurring_schedule,json=recurringSchedule,proto3,oneof"`
}PatchDeployment_State
type PatchDeployment_State int32Represents state of patch peployment.
PatchDeployment_STATE_UNSPECIFIED, PatchDeployment_ACTIVE, PatchDeployment_PAUSED
const (
// The default value. This value is used if the state is omitted.
PatchDeployment_STATE_UNSPECIFIED PatchDeployment_State = 0
// Active value means that patch deployment generates Patch Jobs.
PatchDeployment_ACTIVE PatchDeployment_State = 1
// Paused value means that patch deployment does not generate
// Patch jobs. Requires user action to move in and out from this state.
PatchDeployment_PAUSED PatchDeployment_State = 2
)func (PatchDeployment_State) Descriptor
func (PatchDeployment_State) Descriptor() protoreflect.EnumDescriptorfunc (PatchDeployment_State) Enum
func (x PatchDeployment_State) Enum() *PatchDeployment_Statefunc (PatchDeployment_State) EnumDescriptor
func (PatchDeployment_State) EnumDescriptor() ([]byte, []int)Deprecated: Use PatchDeployment_State.Descriptor instead.
func (PatchDeployment_State) Number
func (x PatchDeployment_State) Number() protoreflect.EnumNumberfunc (PatchDeployment_State) String
func (x PatchDeployment_State) String() stringfunc (PatchDeployment_State) Type
func (PatchDeployment_State) Type() protoreflect.EnumTypePatchInstanceFilter
type PatchInstanceFilter struct {
// Target all VM instances in the project. If true, no other criteria is
// permitted.
All bool `protobuf:"varint,1,opt,name=all,proto3" json:"all,omitempty"`
// 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 []*PatchInstanceFilter_GroupLabel `protobuf:"bytes,2,rep,name=group_labels,json=groupLabels,proto3" json:"group_labels,omitempty"`
// Targets VM instances in ANY of these zones. Leave empty to target VM
// instances in any zone.
Zones []string `protobuf:"bytes,3,rep,name=zones,proto3" json:"zones,omitempty"`
// 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]/instances/[INSTANCE_NAME]`
Instances []string `protobuf:"bytes,4,rep,name=instances,proto3" json:"instances,omitempty"`
// 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 `protobuf:"bytes,5,rep,name=instance_name_prefixes,json=instanceNamePrefixes,proto3" json:"instance_name_prefixes,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*PatchInstanceFilter) Descriptor() ([]byte, []int)Deprecated: Use PatchInstanceFilter.ProtoReflect.Descriptor instead.
func (*PatchInstanceFilter) GetAll
func (x *PatchInstanceFilter) GetAll() boolfunc (*PatchInstanceFilter) GetGroupLabels
func (x *PatchInstanceFilter) GetGroupLabels() []*PatchInstanceFilter_GroupLabelfunc (*PatchInstanceFilter) GetInstanceNamePrefixes
func (x *PatchInstanceFilter) GetInstanceNamePrefixes() []stringfunc (*PatchInstanceFilter) GetInstances
func (x *PatchInstanceFilter) GetInstances() []stringfunc (*PatchInstanceFilter) GetZones
func (x *PatchInstanceFilter) GetZones() []stringfunc (*PatchInstanceFilter) ProtoMessage
func (*PatchInstanceFilter) ProtoMessage()func (*PatchInstanceFilter) ProtoReflect
func (x *PatchInstanceFilter) ProtoReflect() protoreflect.Messagefunc (*PatchInstanceFilter) Reset
func (x *PatchInstanceFilter) Reset()func (*PatchInstanceFilter) String
func (x *PatchInstanceFilter) String() stringPatchInstanceFilter_GroupLabel
type PatchInstanceFilter_GroupLabel struct {
// Compute Engine instance labels that must be present for a VM instance to
// be targeted by this filter.
Labels map[string]string `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".
func (*PatchInstanceFilter_GroupLabel) Descriptor
func (*PatchInstanceFilter_GroupLabel) Descriptor() ([]byte, []int)Deprecated: Use PatchInstanceFilter_GroupLabel.ProtoReflect.Descriptor instead.
func (*PatchInstanceFilter_GroupLabel) GetLabels
func (x *PatchInstanceFilter_GroupLabel) GetLabels() map[string]stringfunc (*PatchInstanceFilter_GroupLabel) ProtoMessage
func (*PatchInstanceFilter_GroupLabel) ProtoMessage()func (*PatchInstanceFilter_GroupLabel) ProtoReflect
func (x *PatchInstanceFilter_GroupLabel) ProtoReflect() protoreflect.Messagefunc (*PatchInstanceFilter_GroupLabel) Reset
func (x *PatchInstanceFilter_GroupLabel) Reset()func (*PatchInstanceFilter_GroupLabel) String
func (x *PatchInstanceFilter_GroupLabel) String() stringPatchJob
type PatchJob struct {
// Unique identifier for this patch job in the form
// `projects/*/patchJobs/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Display name for this patch job. This is not a unique identifier.
DisplayName string `protobuf:"bytes,14,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Description of the patch job. Length of the description is limited
// to 1024 characters.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Time this patch job was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Last time this patch job was updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// The current state of the PatchJob.
State PatchJob_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.osconfig.v1beta.PatchJob_State" json:"state,omitempty"`
// Instances to patch.
InstanceFilter *PatchInstanceFilter `protobuf:"bytes,13,opt,name=instance_filter,json=instanceFilter,proto3" json:"instance_filter,omitempty"`
// Patch configuration being applied.
PatchConfig *PatchConfig `protobuf:"bytes,7,opt,name=patch_config,json=patchConfig,proto3" json:"patch_config,omitempty"`
// Duration of the patch job. After the duration ends, the
// patch job times out.
Duration *durationpb.Duration `protobuf:"bytes,8,opt,name=duration,proto3" json:"duration,omitempty"`
// Summary of instance details.
InstanceDetailsSummary *PatchJob_InstanceDetailsSummary `protobuf:"bytes,9,opt,name=instance_details_summary,json=instanceDetailsSummary,proto3" json:"instance_details_summary,omitempty"`
// 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 `protobuf:"varint,10,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
// If this patch job failed, this message provides information about the
// failure.
ErrorMessage string `protobuf:"bytes,11,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// Reflects the overall progress of the patch job in the range of
// 0.0 being no progress to 100.0 being complete.
PercentComplete float64 `protobuf:"fixed64,12,opt,name=percent_complete,json=percentComplete,proto3" json:"percent_complete,omitempty"`
// Output only. Name of the patch deployment that created this patch job.
PatchDeployment string `protobuf:"bytes,15,opt,name=patch_deployment,json=patchDeployment,proto3" json:"patch_deployment,omitempty"`
// Rollout strategy being applied.
Rollout *PatchRollout `protobuf:"bytes,16,opt,name=rollout,proto3" json:"rollout,omitempty"`
// contains filtered or unexported fields
}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.
func (*PatchJob) Descriptor
Deprecated: Use PatchJob.ProtoReflect.Descriptor instead.
func (*PatchJob) GetCreateTime
func (x *PatchJob) GetCreateTime() *timestamppb.Timestampfunc (*PatchJob) GetDescription
func (*PatchJob) GetDisplayName
func (*PatchJob) GetDryRun
func (*PatchJob) GetDuration
func (x *PatchJob) GetDuration() *durationpb.Durationfunc (*PatchJob) GetErrorMessage
func (*PatchJob) GetInstanceDetailsSummary
func (x *PatchJob) GetInstanceDetailsSummary() *PatchJob_InstanceDetailsSummaryfunc (*PatchJob) GetInstanceFilter
func (x *PatchJob) GetInstanceFilter() *PatchInstanceFilterfunc (*PatchJob) GetName
func (*PatchJob) GetPatchConfig
func (x *PatchJob) GetPatchConfig() *PatchConfigfunc (*PatchJob) GetPatchDeployment
func (*PatchJob) GetPercentComplete
func (*PatchJob) GetRollout
func (x *PatchJob) GetRollout() *PatchRolloutfunc (*PatchJob) GetState
func (x *PatchJob) GetState() PatchJob_Statefunc (*PatchJob) GetUpdateTime
func (x *PatchJob) GetUpdateTime() *timestamppb.Timestampfunc (*PatchJob) ProtoMessage
func (*PatchJob) ProtoMessage()func (*PatchJob) ProtoReflect
func (x *PatchJob) ProtoReflect() protoreflect.Messagefunc (*PatchJob) Reset
func (x *PatchJob) Reset()func (*PatchJob) String
PatchJobInstanceDetails
type PatchJobInstanceDetails struct {
// The instance name in the form `projects/*/zones/*/instances/*`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The unique identifier for the instance. This identifier is
// defined by the server.
InstanceSystemId string `protobuf:"bytes,2,opt,name=instance_system_id,json=instanceSystemId,proto3" json:"instance_system_id,omitempty"`
// Current state of instance patch.
State Instance_PatchState `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.osconfig.v1beta.Instance_PatchState" json:"state,omitempty"`
// If the patch fails, this field provides the reason.
FailureReason string `protobuf:"bytes,4,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
// The number of times the agent that the agent attempts to apply the patch.
AttemptCount int64 `protobuf:"varint,5,opt,name=attempt_count,json=attemptCount,proto3" json:"attempt_count,omitempty"`
// contains filtered or unexported fields
}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.
func (*PatchJobInstanceDetails) Descriptor
func (*PatchJobInstanceDetails) Descriptor() ([]byte, []int)Deprecated: Use PatchJobInstanceDetails.ProtoReflect.Descriptor instead.
func (*PatchJobInstanceDetails) GetAttemptCount
func (x *PatchJobInstanceDetails) GetAttemptCount() int64func (*PatchJobInstanceDetails) GetFailureReason
func (x *PatchJobInstanceDetails) GetFailureReason() stringfunc (*PatchJobInstanceDetails) GetInstanceSystemId
func (x *PatchJobInstanceDetails) GetInstanceSystemId() stringfunc (*PatchJobInstanceDetails) GetName
func (x *PatchJobInstanceDetails) GetName() stringfunc (*PatchJobInstanceDetails) GetState
func (x *PatchJobInstanceDetails) GetState() Instance_PatchStatefunc (*PatchJobInstanceDetails) ProtoMessage
func (*PatchJobInstanceDetails) ProtoMessage()func (*PatchJobInstanceDetails) ProtoReflect
func (x *PatchJobInstanceDetails) ProtoReflect() protoreflect.Messagefunc (*PatchJobInstanceDetails) Reset
func (x *PatchJobInstanceDetails) Reset()func (*PatchJobInstanceDetails) String
func (x *PatchJobInstanceDetails) String() stringPatchJob_InstanceDetailsSummary
type PatchJob_InstanceDetailsSummary struct {
// Number of instances pending patch job.
PendingInstanceCount int64 `protobuf:"varint,1,opt,name=pending_instance_count,json=pendingInstanceCount,proto3" json:"pending_instance_count,omitempty"`
// Number of instances that are inactive.
InactiveInstanceCount int64 `protobuf:"varint,2,opt,name=inactive_instance_count,json=inactiveInstanceCount,proto3" json:"inactive_instance_count,omitempty"`
// Number of instances notified about patch job.
NotifiedInstanceCount int64 `protobuf:"varint,3,opt,name=notified_instance_count,json=notifiedInstanceCount,proto3" json:"notified_instance_count,omitempty"`
// Number of instances that have started.
StartedInstanceCount int64 `protobuf:"varint,4,opt,name=started_instance_count,json=startedInstanceCount,proto3" json:"started_instance_count,omitempty"`
// Number of instances that are downloading patches.
DownloadingPatchesInstanceCount int64 `protobuf:"varint,5,opt,name=downloading_patches_instance_count,json=downloadingPatchesInstanceCount,proto3" json:"downloading_patches_instance_count,omitempty"`
// Number of instances that are applying patches.
ApplyingPatchesInstanceCount int64 `protobuf:"varint,6,opt,name=applying_patches_instance_count,json=applyingPatchesInstanceCount,proto3" json:"applying_patches_instance_count,omitempty"`
// Number of instances rebooting.
RebootingInstanceCount int64 `protobuf:"varint,7,opt,name=rebooting_instance_count,json=rebootingInstanceCount,proto3" json:"rebooting_instance_count,omitempty"`
// Number of instances that have completed successfully.
SucceededInstanceCount int64 `protobuf:"varint,8,opt,name=succeeded_instance_count,json=succeededInstanceCount,proto3" json:"succeeded_instance_count,omitempty"`
// Number of instances that require reboot.
SucceededRebootRequiredInstanceCount int64 `protobuf:"varint,9,opt,name=succeeded_reboot_required_instance_count,json=succeededRebootRequiredInstanceCount,proto3" json:"succeeded_reboot_required_instance_count,omitempty"`
// Number of instances that failed.
FailedInstanceCount int64 `protobuf:"varint,10,opt,name=failed_instance_count,json=failedInstanceCount,proto3" json:"failed_instance_count,omitempty"`
// Number of instances that have acked and will start shortly.
AckedInstanceCount int64 `protobuf:"varint,11,opt,name=acked_instance_count,json=ackedInstanceCount,proto3" json:"acked_instance_count,omitempty"`
// Number of instances that exceeded the time out while applying the patch.
TimedOutInstanceCount int64 `protobuf:"varint,12,opt,name=timed_out_instance_count,json=timedOutInstanceCount,proto3" json:"timed_out_instance_count,omitempty"`
// Number of instances that are running the pre-patch step.
PrePatchStepInstanceCount int64 `protobuf:"varint,13,opt,name=pre_patch_step_instance_count,json=prePatchStepInstanceCount,proto3" json:"pre_patch_step_instance_count,omitempty"`
// Number of instances that are running the post-patch step.
PostPatchStepInstanceCount int64 `protobuf:"varint,14,opt,name=post_patch_step_instance_count,json=postPatchStepInstanceCount,proto3" json:"post_patch_step_instance_count,omitempty"`
// 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 `protobuf:"varint,15,opt,name=no_agent_detected_instance_count,json=noAgentDetectedInstanceCount,proto3" json:"no_agent_detected_instance_count,omitempty"`
// contains filtered or unexported fields
}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 (*PatchJob_InstanceDetailsSummary) Descriptor
func (*PatchJob_InstanceDetailsSummary) Descriptor() ([]byte, []int)Deprecated: Use PatchJob_InstanceDetailsSummary.ProtoReflect.Descriptor instead.
func (*PatchJob_InstanceDetailsSummary) GetAckedInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetAckedInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetApplyingPatchesInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetApplyingPatchesInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetDownloadingPatchesInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetDownloadingPatchesInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetFailedInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetFailedInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetInactiveInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetInactiveInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetNoAgentDetectedInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetNoAgentDetectedInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetNotifiedInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetNotifiedInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetPendingInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetPendingInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetPostPatchStepInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetPostPatchStepInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetPrePatchStepInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetPrePatchStepInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetRebootingInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetRebootingInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetStartedInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetStartedInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetSucceededInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetSucceededInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetSucceededRebootRequiredInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetSucceededRebootRequiredInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) GetTimedOutInstanceCount
func (x *PatchJob_InstanceDetailsSummary) GetTimedOutInstanceCount() int64func (*PatchJob_InstanceDetailsSummary) ProtoMessage
func (*PatchJob_InstanceDetailsSummary) ProtoMessage()func (*PatchJob_InstanceDetailsSummary) ProtoReflect
func (x *PatchJob_InstanceDetailsSummary) ProtoReflect() protoreflect.Messagefunc (*PatchJob_InstanceDetailsSummary) Reset
func (x *PatchJob_InstanceDetailsSummary) Reset()func (*PatchJob_InstanceDetailsSummary) String
func (x *PatchJob_InstanceDetailsSummary) String() stringPatchJob_State
type PatchJob_State int32Enumeration of the various states a patch job passes through as it executes.
PatchJob_STATE_UNSPECIFIED, PatchJob_STARTED, PatchJob_INSTANCE_LOOKUP, PatchJob_PATCHING, PatchJob_SUCCEEDED, PatchJob_COMPLETED_WITH_ERRORS, PatchJob_CANCELED, PatchJob_TIMED_OUT
const (
// State must be specified.
PatchJob_STATE_UNSPECIFIED PatchJob_State = 0
// The patch job was successfully initiated.
PatchJob_STARTED PatchJob_State = 1
// The patch job is looking up instances to run the patch on.
PatchJob_INSTANCE_LOOKUP PatchJob_State = 2
// Instances are being patched.
PatchJob_PATCHING PatchJob_State = 3
// Patch job completed successfully.
PatchJob_SUCCEEDED PatchJob_State = 4
// Patch job completed but there were errors.
PatchJob_COMPLETED_WITH_ERRORS PatchJob_State = 5
// The patch job was canceled.
PatchJob_CANCELED PatchJob_State = 6
// The patch job timed out.
PatchJob_TIMED_OUT PatchJob_State = 7
)func (PatchJob_State) Descriptor
func (PatchJob_State) Descriptor() protoreflect.EnumDescriptorfunc (PatchJob_State) Enum
func (x PatchJob_State) Enum() *PatchJob_Statefunc (PatchJob_State) EnumDescriptor
func (PatchJob_State) EnumDescriptor() ([]byte, []int)Deprecated: Use PatchJob_State.Descriptor instead.
func (PatchJob_State) Number
func (x PatchJob_State) Number() protoreflect.EnumNumberfunc (PatchJob_State) String
func (x PatchJob_State) String() stringfunc (PatchJob_State) Type
func (PatchJob_State) Type() protoreflect.EnumTypePatchRollout
type PatchRollout struct {
// Mode of the patch rollout.
Mode PatchRollout_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.cloud.osconfig.v1beta.PatchRollout_Mode" json:"mode,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=disruption_budget,json=disruptionBudget,proto3" json:"disruption_budget,omitempty"`
// contains filtered or unexported fields
}Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.
func (*PatchRollout) Descriptor
func (*PatchRollout) Descriptor() ([]byte, []int)Deprecated: Use PatchRollout.ProtoReflect.Descriptor instead.
func (*PatchRollout) GetDisruptionBudget
func (x *PatchRollout) GetDisruptionBudget() *FixedOrPercentfunc (*PatchRollout) GetMode
func (x *PatchRollout) GetMode() PatchRollout_Modefunc (*PatchRollout) ProtoMessage
func (*PatchRollout) ProtoMessage()func (*PatchRollout) ProtoReflect
func (x *PatchRollout) ProtoReflect() protoreflect.Messagefunc (*PatchRollout) Reset
func (x *PatchRollout) Reset()func (*PatchRollout) String
func (x *PatchRollout) String() stringPatchRollout_Mode
type PatchRollout_Mode int32Type of the rollout.
PatchRollout_MODE_UNSPECIFIED, PatchRollout_ZONE_BY_ZONE, PatchRollout_CONCURRENT_ZONES
const (
// Mode must be specified.
PatchRollout_MODE_UNSPECIFIED PatchRollout_Mode = 0
// 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.
PatchRollout_ZONE_BY_ZONE PatchRollout_Mode = 1
// Patches are applied to VMs in all zones at the same time.
PatchRollout_CONCURRENT_ZONES PatchRollout_Mode = 2
)func (PatchRollout_Mode) Descriptor
func (PatchRollout_Mode) Descriptor() protoreflect.EnumDescriptorfunc (PatchRollout_Mode) Enum
func (x PatchRollout_Mode) Enum() *PatchRollout_Modefunc (PatchRollout_Mode) EnumDescriptor
func (PatchRollout_Mode) EnumDescriptor() ([]byte, []int)Deprecated: Use PatchRollout_Mode.Descriptor instead.
func (PatchRollout_Mode) Number
func (x PatchRollout_Mode) Number() protoreflect.EnumNumberfunc (PatchRollout_Mode) String
func (x PatchRollout_Mode) String() stringfunc (PatchRollout_Mode) Type
func (PatchRollout_Mode) Type() protoreflect.EnumTypePausePatchDeploymentRequest
type PausePatchDeploymentRequest struct {
// Required. The resource name of the patch deployment in the form
// `projects/*/patchDeployments/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A request message for pausing a patch deployment.
func (*PausePatchDeploymentRequest) Descriptor
func (*PausePatchDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use PausePatchDeploymentRequest.ProtoReflect.Descriptor instead.
func (*PausePatchDeploymentRequest) GetName
func (x *PausePatchDeploymentRequest) GetName() stringfunc (*PausePatchDeploymentRequest) ProtoMessage
func (*PausePatchDeploymentRequest) ProtoMessage()func (*PausePatchDeploymentRequest) ProtoReflect
func (x *PausePatchDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*PausePatchDeploymentRequest) Reset
func (x *PausePatchDeploymentRequest) Reset()func (*PausePatchDeploymentRequest) String
func (x *PausePatchDeploymentRequest) String() stringRecurringSchedule
type RecurringSchedule struct {
// 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 *datetime.TimeZone `protobuf:"bytes,1,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Optional. The time that the recurring schedule becomes effective.
// Defaults to `create_time` of the patch deployment.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Optional. The end time at which a recurring patch deployment schedule is no longer
// active.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Required. Time of the day to run a recurring deployment.
TimeOfDay *timeofday.TimeOfDay `protobuf:"bytes,4,opt,name=time_of_day,json=timeOfDay,proto3" json:"time_of_day,omitempty"`
// Required. The frequency unit of this recurring schedule.
Frequency RecurringSchedule_Frequency `protobuf:"varint,5,opt,name=frequency,proto3,enum=google.cloud.osconfig.v1beta.RecurringSchedule_Frequency" json:"frequency,omitempty"`
// Configurations for this recurring schedule.
// Configurations must match frequency.
//
// Types that are assignable to ScheduleConfig:
//
// *RecurringSchedule_Weekly
// *RecurringSchedule_Monthly
ScheduleConfig isRecurringSchedule_ScheduleConfig `protobuf_oneof:"schedule_config"`
// Output only. The time the last patch job ran successfully.
LastExecuteTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=last_execute_time,json=lastExecuteTime,proto3" json:"last_execute_time,omitempty"`
// Output only. The time the next patch job is scheduled to run.
NextExecuteTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=next_execute_time,json=nextExecuteTime,proto3" json:"next_execute_time,omitempty"`
// contains filtered or unexported fields
}Sets the time for recurring patch deployments.
func (*RecurringSchedule) Descriptor
func (*RecurringSchedule) Descriptor() ([]byte, []int)Deprecated: Use RecurringSchedule.ProtoReflect.Descriptor instead.
func (*RecurringSchedule) GetEndTime
func (x *RecurringSchedule) GetEndTime() *timestamppb.Timestampfunc (*RecurringSchedule) GetFrequency
func (x *RecurringSchedule) GetFrequency() RecurringSchedule_Frequencyfunc (*RecurringSchedule) GetLastExecuteTime
func (x *RecurringSchedule) GetLastExecuteTime() *timestamppb.Timestampfunc (*RecurringSchedule) GetMonthly
func (x *RecurringSchedule) GetMonthly() *MonthlySchedulefunc (*RecurringSchedule) GetNextExecuteTime
func (x *RecurringSchedule) GetNextExecuteTime() *timestamppb.Timestampfunc (*RecurringSchedule) GetScheduleConfig
func (m *RecurringSchedule) GetScheduleConfig() isRecurringSchedule_ScheduleConfigfunc (*RecurringSchedule) GetStartTime
func (x *RecurringSchedule) GetStartTime() *timestamppb.Timestampfunc (*RecurringSchedule) GetTimeOfDay
func (x *RecurringSchedule) GetTimeOfDay() *timeofday.TimeOfDayfunc (*RecurringSchedule) GetTimeZone
func (x *RecurringSchedule) GetTimeZone() *datetime.TimeZonefunc (*RecurringSchedule) GetWeekly
func (x *RecurringSchedule) GetWeekly() *WeeklySchedulefunc (*RecurringSchedule) ProtoMessage
func (*RecurringSchedule) ProtoMessage()func (*RecurringSchedule) ProtoReflect
func (x *RecurringSchedule) ProtoReflect() protoreflect.Messagefunc (*RecurringSchedule) Reset
func (x *RecurringSchedule) Reset()func (*RecurringSchedule) String
func (x *RecurringSchedule) String() stringRecurringSchedule_Frequency
type RecurringSchedule_Frequency int32Specifies the frequency of the recurring patch deployments.
RecurringSchedule_FREQUENCY_UNSPECIFIED, RecurringSchedule_WEEKLY, RecurringSchedule_MONTHLY, RecurringSchedule_DAILY
const (
// Invalid. A frequency must be specified.
RecurringSchedule_FREQUENCY_UNSPECIFIED RecurringSchedule_Frequency = 0
// Indicates that the frequency of recurrence should be expressed in terms
// of weeks.
RecurringSchedule_WEEKLY RecurringSchedule_Frequency = 1
// Indicates that the frequency of recurrence should be expressed in terms
// of months.
RecurringSchedule_MONTHLY RecurringSchedule_Frequency = 2
// Indicates that the frequency of recurrence should be expressed in terms
// of days.
RecurringSchedule_DAILY RecurringSchedule_Frequency = 3
)func (RecurringSchedule_Frequency) Descriptor
func (RecurringSchedule_Frequency) Descriptor() protoreflect.EnumDescriptorfunc (RecurringSchedule_Frequency) Enum
func (x RecurringSchedule_Frequency) Enum() *RecurringSchedule_Frequencyfunc (RecurringSchedule_Frequency) EnumDescriptor
func (RecurringSchedule_Frequency) EnumDescriptor() ([]byte, []int)Deprecated: Use RecurringSchedule_Frequency.Descriptor instead.
func (RecurringSchedule_Frequency) Number
func (x RecurringSchedule_Frequency) Number() protoreflect.EnumNumberfunc (RecurringSchedule_Frequency) String
func (x RecurringSchedule_Frequency) String() stringfunc (RecurringSchedule_Frequency) Type
func (RecurringSchedule_Frequency) Type() protoreflect.EnumTypeRecurringSchedule_Monthly
type RecurringSchedule_Monthly struct {
// Required. Schedule with monthly executions.
Monthly *MonthlySchedule `protobuf:"bytes,7,opt,name=monthly,proto3,oneof"`
}RecurringSchedule_Weekly
type RecurringSchedule_Weekly struct {
// Required. Schedule with weekly executions.
Weekly *WeeklySchedule `protobuf:"bytes,6,opt,name=weekly,proto3,oneof"`
}ResumePatchDeploymentRequest
type ResumePatchDeploymentRequest struct {
// Required. The resource name of the patch deployment in the form
// `projects/*/patchDeployments/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A request message for resuming a patch deployment.
func (*ResumePatchDeploymentRequest) Descriptor
func (*ResumePatchDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use ResumePatchDeploymentRequest.ProtoReflect.Descriptor instead.
func (*ResumePatchDeploymentRequest) GetName
func (x *ResumePatchDeploymentRequest) GetName() stringfunc (*ResumePatchDeploymentRequest) ProtoMessage
func (*ResumePatchDeploymentRequest) ProtoMessage()func (*ResumePatchDeploymentRequest) ProtoReflect
func (x *ResumePatchDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*ResumePatchDeploymentRequest) Reset
func (x *ResumePatchDeploymentRequest) Reset()func (*ResumePatchDeploymentRequest) String
func (x *ResumePatchDeploymentRequest) String() stringSoftwareRecipe
type SoftwareRecipe struct {
// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The version of this software recipe. Version can be up to 4 period
// separated numbers (e.g. 12.34.56.78).
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// Resources available to be used in the steps in the recipe.
Artifacts []*SoftwareRecipe_Artifact `protobuf:"bytes,3,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
// 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 []*SoftwareRecipe_Step `protobuf:"bytes,4,rep,name=install_steps,json=installSteps,proto3" json:"install_steps,omitempty"`
// 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 []*SoftwareRecipe_Step `protobuf:"bytes,5,rep,name=update_steps,json=updateSteps,proto3" json:"update_steps,omitempty"`
// 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.
DesiredState DesiredState `protobuf:"varint,6,opt,name=desired_state,json=desiredState,proto3,enum=google.cloud.osconfig.v1beta.DesiredState" json:"desired_state,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*SoftwareRecipe) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe) GetArtifacts
func (x *SoftwareRecipe) GetArtifacts() []*SoftwareRecipe_Artifactfunc (*SoftwareRecipe) GetDesiredState
func (x *SoftwareRecipe) GetDesiredState() DesiredStatefunc (*SoftwareRecipe) GetInstallSteps
func (x *SoftwareRecipe) GetInstallSteps() []*SoftwareRecipe_Stepfunc (*SoftwareRecipe) GetName
func (x *SoftwareRecipe) GetName() stringfunc (*SoftwareRecipe) GetUpdateSteps
func (x *SoftwareRecipe) GetUpdateSteps() []*SoftwareRecipe_Stepfunc (*SoftwareRecipe) GetVersion
func (x *SoftwareRecipe) GetVersion() stringfunc (*SoftwareRecipe) ProtoMessage
func (*SoftwareRecipe) ProtoMessage()func (*SoftwareRecipe) ProtoReflect
func (x *SoftwareRecipe) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe) Reset
func (x *SoftwareRecipe) Reset()func (*SoftwareRecipe) String
func (x *SoftwareRecipe) String() stringSoftwareRecipe_Artifact
type SoftwareRecipe_Artifact struct {
// 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 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// A specific type of artifact.
//
// Types that are assignable to Artifact:
//
// *SoftwareRecipe_Artifact_Remote_
// *SoftwareRecipe_Artifact_Gcs_
Artifact isSoftwareRecipe_Artifact_Artifact `protobuf_oneof:"artifact"`
// 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 `protobuf:"varint,4,opt,name=allow_insecure,json=allowInsecure,proto3" json:"allow_insecure,omitempty"`
// contains filtered or unexported fields
}Specifies a resource to be used in the recipe.
func (*SoftwareRecipe_Artifact) Descriptor
func (*SoftwareRecipe_Artifact) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Artifact.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Artifact) GetAllowInsecure
func (x *SoftwareRecipe_Artifact) GetAllowInsecure() boolfunc (*SoftwareRecipe_Artifact) GetArtifact
func (m *SoftwareRecipe_Artifact) GetArtifact() isSoftwareRecipe_Artifact_Artifactfunc (*SoftwareRecipe_Artifact) GetGcs
func (x *SoftwareRecipe_Artifact) GetGcs() *SoftwareRecipe_Artifact_Gcsfunc (*SoftwareRecipe_Artifact) GetId
func (x *SoftwareRecipe_Artifact) GetId() stringfunc (*SoftwareRecipe_Artifact) GetRemote
func (x *SoftwareRecipe_Artifact) GetRemote() *SoftwareRecipe_Artifact_Remotefunc (*SoftwareRecipe_Artifact) ProtoMessage
func (*SoftwareRecipe_Artifact) ProtoMessage()func (*SoftwareRecipe_Artifact) ProtoReflect
func (x *SoftwareRecipe_Artifact) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Artifact) Reset
func (x *SoftwareRecipe_Artifact) Reset()func (*SoftwareRecipe_Artifact) String
func (x *SoftwareRecipe_Artifact) String() stringSoftwareRecipe_Artifact_Gcs
type SoftwareRecipe_Artifact_Gcs struct {
// 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 `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// 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 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
// contains filtered or unexported fields
}Specifies an artifact available as a Google Cloud Storage object.
func (*SoftwareRecipe_Artifact_Gcs) Descriptor
func (*SoftwareRecipe_Artifact_Gcs) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Artifact_Gcs.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Artifact_Gcs) GetBucket
func (x *SoftwareRecipe_Artifact_Gcs) GetBucket() stringfunc (*SoftwareRecipe_Artifact_Gcs) GetGeneration
func (x *SoftwareRecipe_Artifact_Gcs) GetGeneration() int64func (*SoftwareRecipe_Artifact_Gcs) GetObject
func (x *SoftwareRecipe_Artifact_Gcs) GetObject() stringfunc (*SoftwareRecipe_Artifact_Gcs) ProtoMessage
func (*SoftwareRecipe_Artifact_Gcs) ProtoMessage()func (*SoftwareRecipe_Artifact_Gcs) ProtoReflect
func (x *SoftwareRecipe_Artifact_Gcs) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Artifact_Gcs) Reset
func (x *SoftwareRecipe_Artifact_Gcs) Reset()func (*SoftwareRecipe_Artifact_Gcs) String
func (x *SoftwareRecipe_Artifact_Gcs) String() stringSoftwareRecipe_Artifact_Gcs_
type SoftwareRecipe_Artifact_Gcs_ struct {
// A Google Cloud Storage artifact.
Gcs *SoftwareRecipe_Artifact_Gcs `protobuf:"bytes,3,opt,name=gcs,proto3,oneof"`
}SoftwareRecipe_Artifact_Remote
type SoftwareRecipe_Artifact_Remote struct {
// URI from which to fetch the object. It should contain both the protocol
// and path following the format {protocol}://{location}.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=checksum,proto3" json:"checksum,omitempty"`
// contains filtered or unexported fields
}Specifies an artifact available via some URI.
func (*SoftwareRecipe_Artifact_Remote) Descriptor
func (*SoftwareRecipe_Artifact_Remote) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Artifact_Remote.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Artifact_Remote) GetChecksum
func (x *SoftwareRecipe_Artifact_Remote) GetChecksum() stringfunc (*SoftwareRecipe_Artifact_Remote) GetUri
func (x *SoftwareRecipe_Artifact_Remote) GetUri() stringfunc (*SoftwareRecipe_Artifact_Remote) ProtoMessage
func (*SoftwareRecipe_Artifact_Remote) ProtoMessage()func (*SoftwareRecipe_Artifact_Remote) ProtoReflect
func (x *SoftwareRecipe_Artifact_Remote) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Artifact_Remote) Reset
func (x *SoftwareRecipe_Artifact_Remote) Reset()func (*SoftwareRecipe_Artifact_Remote) String
func (x *SoftwareRecipe_Artifact_Remote) String() stringSoftwareRecipe_Artifact_Remote_
type SoftwareRecipe_Artifact_Remote_ struct {
// A generic remote artifact.
Remote *SoftwareRecipe_Artifact_Remote `protobuf:"bytes,2,opt,name=remote,proto3,oneof"`
}SoftwareRecipe_Step
type SoftwareRecipe_Step struct {
// A specific type of step.
//
// Types that are assignable to Step:
//
// *SoftwareRecipe_Step_FileCopy
// *SoftwareRecipe_Step_ArchiveExtraction
// *SoftwareRecipe_Step_MsiInstallation
// *SoftwareRecipe_Step_DpkgInstallation
// *SoftwareRecipe_Step_RpmInstallation
// *SoftwareRecipe_Step_FileExec
// *SoftwareRecipe_Step_ScriptRun
Step isSoftwareRecipe_Step_Step `protobuf_oneof:"step"`
// contains filtered or unexported fields
}An action that can be taken as part of installing or updating a recipe.
func (*SoftwareRecipe_Step) Descriptor
func (*SoftwareRecipe_Step) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step) GetArchiveExtraction
func (x *SoftwareRecipe_Step) GetArchiveExtraction() *SoftwareRecipe_Step_ExtractArchivefunc (*SoftwareRecipe_Step) GetDpkgInstallation
func (x *SoftwareRecipe_Step) GetDpkgInstallation() *SoftwareRecipe_Step_InstallDpkgfunc (*SoftwareRecipe_Step) GetFileCopy
func (x *SoftwareRecipe_Step) GetFileCopy() *SoftwareRecipe_Step_CopyFilefunc (*SoftwareRecipe_Step) GetFileExec
func (x *SoftwareRecipe_Step) GetFileExec() *SoftwareRecipe_Step_ExecFilefunc (*SoftwareRecipe_Step) GetMsiInstallation
func (x *SoftwareRecipe_Step) GetMsiInstallation() *SoftwareRecipe_Step_InstallMsifunc (*SoftwareRecipe_Step) GetRpmInstallation
func (x *SoftwareRecipe_Step) GetRpmInstallation() *SoftwareRecipe_Step_InstallRpmfunc (*SoftwareRecipe_Step) GetScriptRun
func (x *SoftwareRecipe_Step) GetScriptRun() *SoftwareRecipe_Step_RunScriptfunc (*SoftwareRecipe_Step) GetStep
func (m *SoftwareRecipe_Step) GetStep() isSoftwareRecipe_Step_Stepfunc (*SoftwareRecipe_Step) ProtoMessage
func (*SoftwareRecipe_Step) ProtoMessage()func (*SoftwareRecipe_Step) ProtoReflect
func (x *SoftwareRecipe_Step) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step) Reset
func (x *SoftwareRecipe_Step) Reset()func (*SoftwareRecipe_Step) String
func (x *SoftwareRecipe_Step) String() stringSoftwareRecipe_Step_ArchiveExtraction
type SoftwareRecipe_Step_ArchiveExtraction struct {
// Extracts an archive into the specified directory.
ArchiveExtraction *SoftwareRecipe_Step_ExtractArchive `protobuf:"bytes,2,opt,name=archive_extraction,json=archiveExtraction,proto3,oneof"`
}SoftwareRecipe_Step_CopyFile
type SoftwareRecipe_Step_CopyFile struct {
// Required. The id of the relevant artifact in the recipe.
ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
// Required. The absolute path on the instance to put the file.
Destination string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`
// 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 `protobuf:"varint,3,opt,name=overwrite,proto3" json:"overwrite,omitempty"`
// 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 `protobuf:"bytes,4,opt,name=permissions,proto3" json:"permissions,omitempty"`
// contains filtered or unexported fields
}Copies the artifact to the specified path on the instance.
func (*SoftwareRecipe_Step_CopyFile) Descriptor
func (*SoftwareRecipe_Step_CopyFile) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_CopyFile.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_CopyFile) GetArtifactId
func (x *SoftwareRecipe_Step_CopyFile) GetArtifactId() stringfunc (*SoftwareRecipe_Step_CopyFile) GetDestination
func (x *SoftwareRecipe_Step_CopyFile) GetDestination() stringfunc (*SoftwareRecipe_Step_CopyFile) GetOverwrite
func (x *SoftwareRecipe_Step_CopyFile) GetOverwrite() boolfunc (*SoftwareRecipe_Step_CopyFile) GetPermissions
func (x *SoftwareRecipe_Step_CopyFile) GetPermissions() stringfunc (*SoftwareRecipe_Step_CopyFile) ProtoMessage
func (*SoftwareRecipe_Step_CopyFile) ProtoMessage()func (*SoftwareRecipe_Step_CopyFile) ProtoReflect
func (x *SoftwareRecipe_Step_CopyFile) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_CopyFile) Reset
func (x *SoftwareRecipe_Step_CopyFile) Reset()func (*SoftwareRecipe_Step_CopyFile) String
func (x *SoftwareRecipe_Step_CopyFile) String() stringSoftwareRecipe_Step_DpkgInstallation
type SoftwareRecipe_Step_DpkgInstallation struct {
// Installs a deb file via dpkg.
DpkgInstallation *SoftwareRecipe_Step_InstallDpkg `protobuf:"bytes,4,opt,name=dpkg_installation,json=dpkgInstallation,proto3,oneof"`
}SoftwareRecipe_Step_ExecFile
type SoftwareRecipe_Step_ExecFile struct {
// Location of the file to execute.
//
// Types that are assignable to LocationType:
//
// *SoftwareRecipe_Step_ExecFile_ArtifactId
// *SoftwareRecipe_Step_ExecFile_LocalPath
LocationType isSoftwareRecipe_Step_ExecFile_LocationType `protobuf_oneof:"location_type"`
// Arguments to be passed to the provided executable.
Args []string `protobuf:"bytes,3,rep,name=args,proto3" json:"args,omitempty"`
// Defaults to [0]. A list of possible return values that the program
// can return to indicate a success.
AllowedExitCodes []int32 `protobuf:"varint,4,rep,packed,name=allowed_exit_codes,json=allowedExitCodes,proto3" json:"allowed_exit_codes,omitempty"`
// contains filtered or unexported fields
}Executes an artifact or local file.
func (*SoftwareRecipe_Step_ExecFile) Descriptor
func (*SoftwareRecipe_Step_ExecFile) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_ExecFile.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_ExecFile) GetAllowedExitCodes
func (x *SoftwareRecipe_Step_ExecFile) GetAllowedExitCodes() []int32func (*SoftwareRecipe_Step_ExecFile) GetArgs
func (x *SoftwareRecipe_Step_ExecFile) GetArgs() []stringfunc (*SoftwareRecipe_Step_ExecFile) GetArtifactId
func (x *SoftwareRecipe_Step_ExecFile) GetArtifactId() stringfunc (*SoftwareRecipe_Step_ExecFile) GetLocalPath
func (x *SoftwareRecipe_Step_ExecFile) GetLocalPath() stringfunc (*SoftwareRecipe_Step_ExecFile) GetLocationType
func (m *SoftwareRecipe_Step_ExecFile) GetLocationType() isSoftwareRecipe_Step_ExecFile_LocationTypefunc (*SoftwareRecipe_Step_ExecFile) ProtoMessage
func (*SoftwareRecipe_Step_ExecFile) ProtoMessage()func (*SoftwareRecipe_Step_ExecFile) ProtoReflect
func (x *SoftwareRecipe_Step_ExecFile) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_ExecFile) Reset
func (x *SoftwareRecipe_Step_ExecFile) Reset()func (*SoftwareRecipe_Step_ExecFile) String
func (x *SoftwareRecipe_Step_ExecFile) String() stringSoftwareRecipe_Step_ExecFile_ArtifactId
type SoftwareRecipe_Step_ExecFile_ArtifactId struct {
// The id of the relevant artifact in the recipe.
ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3,oneof"`
}SoftwareRecipe_Step_ExecFile_LocalPath
type SoftwareRecipe_Step_ExecFile_LocalPath struct {
// The absolute path of the file on the local filesystem.
LocalPath string `protobuf:"bytes,2,opt,name=local_path,json=localPath,proto3,oneof"`
}SoftwareRecipe_Step_ExtractArchive
type SoftwareRecipe_Step_ExtractArchive struct {
// Required. The id of the relevant artifact in the recipe.
ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
// Directory to extract archive to.
// Defaults to `/` on Linux or `C:\` on Windows.
Destination string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`
// Required. The type of the archive to extract.
Type SoftwareRecipe_Step_ExtractArchive_ArchiveType `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.osconfig.v1beta.SoftwareRecipe_Step_ExtractArchive_ArchiveType" json:"type,omitempty"`
// contains filtered or unexported fields
}Extracts an archive of the type specified in the specified directory.
func (*SoftwareRecipe_Step_ExtractArchive) Descriptor
func (*SoftwareRecipe_Step_ExtractArchive) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_ExtractArchive.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_ExtractArchive) GetArtifactId
func (x *SoftwareRecipe_Step_ExtractArchive) GetArtifactId() stringfunc (*SoftwareRecipe_Step_ExtractArchive) GetDestination
func (x *SoftwareRecipe_Step_ExtractArchive) GetDestination() stringfunc (*SoftwareRecipe_Step_ExtractArchive) GetType
func (x *SoftwareRecipe_Step_ExtractArchive) GetType() SoftwareRecipe_Step_ExtractArchive_ArchiveTypefunc (*SoftwareRecipe_Step_ExtractArchive) ProtoMessage
func (*SoftwareRecipe_Step_ExtractArchive) ProtoMessage()func (*SoftwareRecipe_Step_ExtractArchive) ProtoReflect
func (x *SoftwareRecipe_Step_ExtractArchive) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_ExtractArchive) Reset
func (x *SoftwareRecipe_Step_ExtractArchive) Reset()func (*SoftwareRecipe_Step_ExtractArchive) String
func (x *SoftwareRecipe_Step_ExtractArchive) String() stringSoftwareRecipe_Step_ExtractArchive_ArchiveType
type SoftwareRecipe_Step_ExtractArchive_ArchiveType int32Specifying the type of archive.
SoftwareRecipe_Step_ExtractArchive_ARCHIVE_TYPE_UNSPECIFIED, SoftwareRecipe_Step_ExtractArchive_TAR, SoftwareRecipe_Step_ExtractArchive_TAR_GZIP, SoftwareRecipe_Step_ExtractArchive_TAR_BZIP, SoftwareRecipe_Step_ExtractArchive_TAR_LZMA, SoftwareRecipe_Step_ExtractArchive_TAR_XZ, SoftwareRecipe_Step_ExtractArchive_ZIP
const (
// Indicates that the archive type isn't specified.
SoftwareRecipe_Step_ExtractArchive_ARCHIVE_TYPE_UNSPECIFIED SoftwareRecipe_Step_ExtractArchive_ArchiveType = 0
// Indicates that the archive is a tar archive with no encryption.
SoftwareRecipe_Step_ExtractArchive_TAR SoftwareRecipe_Step_ExtractArchive_ArchiveType = 1
// Indicates that the archive is a tar archive with gzip encryption.
SoftwareRecipe_Step_ExtractArchive_TAR_GZIP SoftwareRecipe_Step_ExtractArchive_ArchiveType = 2
// Indicates that the archive is a tar archive with bzip encryption.
SoftwareRecipe_Step_ExtractArchive_TAR_BZIP SoftwareRecipe_Step_ExtractArchive_ArchiveType = 3
// Indicates that the archive is a tar archive with lzma encryption.
SoftwareRecipe_Step_ExtractArchive_TAR_LZMA SoftwareRecipe_Step_ExtractArchive_ArchiveType = 4
// Indicates that the archive is a tar archive with xz encryption.
SoftwareRecipe_Step_ExtractArchive_TAR_XZ SoftwareRecipe_Step_ExtractArchive_ArchiveType = 5
// Indicates that the archive is a zip archive.
SoftwareRecipe_Step_ExtractArchive_ZIP SoftwareRecipe_Step_ExtractArchive_ArchiveType = 11
)func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) Descriptor
func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) Descriptor() protoreflect.EnumDescriptorfunc (SoftwareRecipe_Step_ExtractArchive_ArchiveType) Enum
func (x SoftwareRecipe_Step_ExtractArchive_ArchiveType) Enum() *SoftwareRecipe_Step_ExtractArchive_ArchiveTypefunc (SoftwareRecipe_Step_ExtractArchive_ArchiveType) EnumDescriptor
func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) EnumDescriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_ExtractArchive_ArchiveType.Descriptor instead.
func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) Number
func (x SoftwareRecipe_Step_ExtractArchive_ArchiveType) Number() protoreflect.EnumNumberfunc (SoftwareRecipe_Step_ExtractArchive_ArchiveType) String
func (x SoftwareRecipe_Step_ExtractArchive_ArchiveType) String() stringfunc (SoftwareRecipe_Step_ExtractArchive_ArchiveType) Type
SoftwareRecipe_Step_FileCopy
type SoftwareRecipe_Step_FileCopy struct {
// Copies a file onto the instance.
FileCopy *SoftwareRecipe_Step_CopyFile `protobuf:"bytes,1,opt,name=file_copy,json=fileCopy,proto3,oneof"`
}SoftwareRecipe_Step_FileExec
type SoftwareRecipe_Step_FileExec struct {
// Executes an artifact or local file.
FileExec *SoftwareRecipe_Step_ExecFile `protobuf:"bytes,6,opt,name=file_exec,json=fileExec,proto3,oneof"`
}SoftwareRecipe_Step_InstallDpkg
type SoftwareRecipe_Step_InstallDpkg struct {
// Required. The id of the relevant artifact in the recipe.
ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
// contains filtered or unexported fields
}Installs a deb via dpkg.
func (*SoftwareRecipe_Step_InstallDpkg) Descriptor
func (*SoftwareRecipe_Step_InstallDpkg) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_InstallDpkg.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_InstallDpkg) GetArtifactId
func (x *SoftwareRecipe_Step_InstallDpkg) GetArtifactId() stringfunc (*SoftwareRecipe_Step_InstallDpkg) ProtoMessage
func (*SoftwareRecipe_Step_InstallDpkg) ProtoMessage()func (*SoftwareRecipe_Step_InstallDpkg) ProtoReflect
func (x *SoftwareRecipe_Step_InstallDpkg) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_InstallDpkg) Reset
func (x *SoftwareRecipe_Step_InstallDpkg) Reset()func (*SoftwareRecipe_Step_InstallDpkg) String
func (x *SoftwareRecipe_Step_InstallDpkg) String() stringSoftwareRecipe_Step_InstallMsi
type SoftwareRecipe_Step_InstallMsi struct {
// Required. The id of the relevant artifact in the recipe.
ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
// The flags to use when installing the MSI
// defaults to ["/i"] (i.e. the install flag).
Flags []string `protobuf:"bytes,2,rep,name=flags,proto3" json:"flags,omitempty"`
// Return codes that indicate that the software installed or updated
// successfully. Behaviour defaults to [0]
AllowedExitCodes []int32 `protobuf:"varint,3,rep,packed,name=allowed_exit_codes,json=allowedExitCodes,proto3" json:"allowed_exit_codes,omitempty"`
// contains filtered or unexported fields
}Installs an MSI file.
func (*SoftwareRecipe_Step_InstallMsi) Descriptor
func (*SoftwareRecipe_Step_InstallMsi) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_InstallMsi.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_InstallMsi) GetAllowedExitCodes
func (x *SoftwareRecipe_Step_InstallMsi) GetAllowedExitCodes() []int32func (*SoftwareRecipe_Step_InstallMsi) GetArtifactId
func (x *SoftwareRecipe_Step_InstallMsi) GetArtifactId() stringfunc (*SoftwareRecipe_Step_InstallMsi) GetFlags
func (x *SoftwareRecipe_Step_InstallMsi) GetFlags() []stringfunc (*SoftwareRecipe_Step_InstallMsi) ProtoMessage
func (*SoftwareRecipe_Step_InstallMsi) ProtoMessage()func (*SoftwareRecipe_Step_InstallMsi) ProtoReflect
func (x *SoftwareRecipe_Step_InstallMsi) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_InstallMsi) Reset
func (x *SoftwareRecipe_Step_InstallMsi) Reset()func (*SoftwareRecipe_Step_InstallMsi) String
func (x *SoftwareRecipe_Step_InstallMsi) String() stringSoftwareRecipe_Step_InstallRpm
type SoftwareRecipe_Step_InstallRpm struct {
// Required. The id of the relevant artifact in the recipe.
ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`
// contains filtered or unexported fields
}Installs an rpm file via the rpm utility.
func (*SoftwareRecipe_Step_InstallRpm) Descriptor
func (*SoftwareRecipe_Step_InstallRpm) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_InstallRpm.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_InstallRpm) GetArtifactId
func (x *SoftwareRecipe_Step_InstallRpm) GetArtifactId() stringfunc (*SoftwareRecipe_Step_InstallRpm) ProtoMessage
func (*SoftwareRecipe_Step_InstallRpm) ProtoMessage()func (*SoftwareRecipe_Step_InstallRpm) ProtoReflect
func (x *SoftwareRecipe_Step_InstallRpm) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_InstallRpm) Reset
func (x *SoftwareRecipe_Step_InstallRpm) Reset()func (*SoftwareRecipe_Step_InstallRpm) String
func (x *SoftwareRecipe_Step_InstallRpm) String() stringSoftwareRecipe_Step_MsiInstallation
type SoftwareRecipe_Step_MsiInstallation struct {
// Installs an MSI file.
MsiInstallation *SoftwareRecipe_Step_InstallMsi `protobuf:"bytes,3,opt,name=msi_installation,json=msiInstallation,proto3,oneof"`
}SoftwareRecipe_Step_RpmInstallation
type SoftwareRecipe_Step_RpmInstallation struct {
// Installs an rpm file via the rpm utility.
RpmInstallation *SoftwareRecipe_Step_InstallRpm `protobuf:"bytes,5,opt,name=rpm_installation,json=rpmInstallation,proto3,oneof"`
}SoftwareRecipe_Step_RunScript
type SoftwareRecipe_Step_RunScript struct {
// Required. The shell script to be executed.
Script string `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`
// Return codes that indicate that the software installed or updated
// successfully. Behaviour defaults to [0]
AllowedExitCodes []int32 `protobuf:"varint,2,rep,packed,name=allowed_exit_codes,json=allowedExitCodes,proto3" json:"allowed_exit_codes,omitempty"`
// 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\)).
Interpreter SoftwareRecipe_Step_RunScript_Interpreter `protobuf:"varint,3,opt,name=interpreter,proto3,enum=google.cloud.osconfig.v1beta.SoftwareRecipe_Step_RunScript_Interpreter" json:"interpreter,omitempty"`
// contains filtered or unexported fields
}Runs a script through an interpreter.
func (*SoftwareRecipe_Step_RunScript) Descriptor
func (*SoftwareRecipe_Step_RunScript) Descriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_RunScript.ProtoReflect.Descriptor instead.
func (*SoftwareRecipe_Step_RunScript) GetAllowedExitCodes
func (x *SoftwareRecipe_Step_RunScript) GetAllowedExitCodes() []int32func (*SoftwareRecipe_Step_RunScript) GetInterpreter
func (x *SoftwareRecipe_Step_RunScript) GetInterpreter() SoftwareRecipe_Step_RunScript_Interpreterfunc (*SoftwareRecipe_Step_RunScript) GetScript
func (x *SoftwareRecipe_Step_RunScript) GetScript() stringfunc (*SoftwareRecipe_Step_RunScript) ProtoMessage
func (*SoftwareRecipe_Step_RunScript) ProtoMessage()func (*SoftwareRecipe_Step_RunScript) ProtoReflect
func (x *SoftwareRecipe_Step_RunScript) ProtoReflect() protoreflect.Messagefunc (*SoftwareRecipe_Step_RunScript) Reset
func (x *SoftwareRecipe_Step_RunScript) Reset()func (*SoftwareRecipe_Step_RunScript) String
func (x *SoftwareRecipe_Step_RunScript) String() stringSoftwareRecipe_Step_RunScript_Interpreter
type SoftwareRecipe_Step_RunScript_Interpreter int32The interpreter used to execute a script.
SoftwareRecipe_Step_RunScript_INTERPRETER_UNSPECIFIED, SoftwareRecipe_Step_RunScript_SHELL, SoftwareRecipe_Step_RunScript_POWERSHELL
const (
// Default value for ScriptType.
SoftwareRecipe_Step_RunScript_INTERPRETER_UNSPECIFIED SoftwareRecipe_Step_RunScript_Interpreter = 0
// Indicates that the script is run with `/bin/sh` on Linux and `cmd`
// on windows.
SoftwareRecipe_Step_RunScript_SHELL SoftwareRecipe_Step_RunScript_Interpreter = 1
// Indicates that the script is run with powershell.
SoftwareRecipe_Step_RunScript_POWERSHELL SoftwareRecipe_Step_RunScript_Interpreter = 3
)func (SoftwareRecipe_Step_RunScript_Interpreter) Descriptor
func (SoftwareRecipe_Step_RunScript_Interpreter) Descriptor() protoreflect.EnumDescriptorfunc (SoftwareRecipe_Step_RunScript_Interpreter) Enum
func (x SoftwareRecipe_Step_RunScript_Interpreter) Enum() *SoftwareRecipe_Step_RunScript_Interpreterfunc (SoftwareRecipe_Step_RunScript_Interpreter) EnumDescriptor
func (SoftwareRecipe_Step_RunScript_Interpreter) EnumDescriptor() ([]byte, []int)Deprecated: Use SoftwareRecipe_Step_RunScript_Interpreter.Descriptor instead.
func (SoftwareRecipe_Step_RunScript_Interpreter) Number
func (x SoftwareRecipe_Step_RunScript_Interpreter) Number() protoreflect.EnumNumberfunc (SoftwareRecipe_Step_RunScript_Interpreter) String
func (x SoftwareRecipe_Step_RunScript_Interpreter) String() stringfunc (SoftwareRecipe_Step_RunScript_Interpreter) Type
func (SoftwareRecipe_Step_RunScript_Interpreter) Type() protoreflect.EnumTypeSoftwareRecipe_Step_ScriptRun
type SoftwareRecipe_Step_ScriptRun struct {
// Runs commands in a shell.
ScriptRun *SoftwareRecipe_Step_RunScript `protobuf:"bytes,7,opt,name=script_run,json=scriptRun,proto3,oneof"`
}UnimplementedOsConfigServiceServer
type UnimplementedOsConfigServiceServer struct {
}UnimplementedOsConfigServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedOsConfigServiceServer) CancelPatchJob
func (UnimplementedOsConfigServiceServer) CancelPatchJob(context.Context, *CancelPatchJobRequest) (*PatchJob, error)func (UnimplementedOsConfigServiceServer) CreateGuestPolicy
func (UnimplementedOsConfigServiceServer) CreateGuestPolicy(context.Context, *CreateGuestPolicyRequest) (*GuestPolicy, error)func (UnimplementedOsConfigServiceServer) CreatePatchDeployment
func (UnimplementedOsConfigServiceServer) CreatePatchDeployment(context.Context, *CreatePatchDeploymentRequest) (*PatchDeployment, error)func (UnimplementedOsConfigServiceServer) DeleteGuestPolicy
func (UnimplementedOsConfigServiceServer) DeleteGuestPolicy(context.Context, *DeleteGuestPolicyRequest) (*emptypb.Empty, error)func (UnimplementedOsConfigServiceServer) DeletePatchDeployment
func (UnimplementedOsConfigServiceServer) DeletePatchDeployment(context.Context, *DeletePatchDeploymentRequest) (*emptypb.Empty, error)func (UnimplementedOsConfigServiceServer) ExecutePatchJob
func (UnimplementedOsConfigServiceServer) ExecutePatchJob(context.Context, *ExecutePatchJobRequest) (*PatchJob, error)func (UnimplementedOsConfigServiceServer) GetGuestPolicy
func (UnimplementedOsConfigServiceServer) GetGuestPolicy(context.Context, *GetGuestPolicyRequest) (*GuestPolicy, error)func (UnimplementedOsConfigServiceServer) GetPatchDeployment
func (UnimplementedOsConfigServiceServer) GetPatchDeployment(context.Context, *GetPatchDeploymentRequest) (*PatchDeployment, error)func (UnimplementedOsConfigServiceServer) GetPatchJob
func (UnimplementedOsConfigServiceServer) GetPatchJob(context.Context, *GetPatchJobRequest) (*PatchJob, error)func (UnimplementedOsConfigServiceServer) ListGuestPolicies
func (UnimplementedOsConfigServiceServer) ListGuestPolicies(context.Context, *ListGuestPoliciesRequest) (*ListGuestPoliciesResponse, error)func (UnimplementedOsConfigServiceServer) ListPatchDeployments
func (UnimplementedOsConfigServiceServer) ListPatchDeployments(context.Context, *ListPatchDeploymentsRequest) (*ListPatchDeploymentsResponse, error)func (UnimplementedOsConfigServiceServer) ListPatchJobInstanceDetails
func (UnimplementedOsConfigServiceServer) ListPatchJobInstanceDetails(context.Context, *ListPatchJobInstanceDetailsRequest) (*ListPatchJobInstanceDetailsResponse, error)func (UnimplementedOsConfigServiceServer) ListPatchJobs
func (UnimplementedOsConfigServiceServer) ListPatchJobs(context.Context, *ListPatchJobsRequest) (*ListPatchJobsResponse, error)func (UnimplementedOsConfigServiceServer) LookupEffectiveGuestPolicy
func (UnimplementedOsConfigServiceServer) LookupEffectiveGuestPolicy(context.Context, *LookupEffectiveGuestPolicyRequest) (*EffectiveGuestPolicy, error)func (UnimplementedOsConfigServiceServer) PausePatchDeployment
func (UnimplementedOsConfigServiceServer) PausePatchDeployment(context.Context, *PausePatchDeploymentRequest) (*PatchDeployment, error)func (UnimplementedOsConfigServiceServer) ResumePatchDeployment
func (UnimplementedOsConfigServiceServer) ResumePatchDeployment(context.Context, *ResumePatchDeploymentRequest) (*PatchDeployment, error)func (UnimplementedOsConfigServiceServer) UpdateGuestPolicy
func (UnimplementedOsConfigServiceServer) UpdateGuestPolicy(context.Context, *UpdateGuestPolicyRequest) (*GuestPolicy, error)func (UnimplementedOsConfigServiceServer) UpdatePatchDeployment
func (UnimplementedOsConfigServiceServer) UpdatePatchDeployment(context.Context, *UpdatePatchDeploymentRequest) (*PatchDeployment, error)UnsafeOsConfigServiceServer
type UnsafeOsConfigServiceServer interface {
// contains filtered or unexported methods
}UnsafeOsConfigServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OsConfigServiceServer will result in compilation errors.
UpdateGuestPolicyRequest
type UpdateGuestPolicyRequest struct {
// Required. The updated GuestPolicy.
GuestPolicy *GuestPolicy `protobuf:"bytes,1,opt,name=guest_policy,json=guestPolicy,proto3" json:"guest_policy,omitempty"`
// Field mask that controls which fields of the guest policy should be
// updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}A request message for updating a guest policy.
func (*UpdateGuestPolicyRequest) Descriptor
func (*UpdateGuestPolicyRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateGuestPolicyRequest.ProtoReflect.Descriptor instead.
func (*UpdateGuestPolicyRequest) GetGuestPolicy
func (x *UpdateGuestPolicyRequest) GetGuestPolicy() *GuestPolicyfunc (*UpdateGuestPolicyRequest) GetUpdateMask
func (x *UpdateGuestPolicyRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateGuestPolicyRequest) ProtoMessage
func (*UpdateGuestPolicyRequest) ProtoMessage()func (*UpdateGuestPolicyRequest) ProtoReflect
func (x *UpdateGuestPolicyRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateGuestPolicyRequest) Reset
func (x *UpdateGuestPolicyRequest) Reset()func (*UpdateGuestPolicyRequest) String
func (x *UpdateGuestPolicyRequest) String() stringUpdatePatchDeploymentRequest
type UpdatePatchDeploymentRequest struct {
// Required. The patch deployment to Update.
PatchDeployment *PatchDeployment `protobuf:"bytes,1,opt,name=patch_deployment,json=patchDeployment,proto3" json:"patch_deployment,omitempty"`
// Optional. Field mask that controls which fields of the patch deployment should be
// updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}A request message for updating a patch deployment.
func (*UpdatePatchDeploymentRequest) Descriptor
func (*UpdatePatchDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdatePatchDeploymentRequest.ProtoReflect.Descriptor instead.
func (*UpdatePatchDeploymentRequest) GetPatchDeployment
func (x *UpdatePatchDeploymentRequest) GetPatchDeployment() *PatchDeploymentfunc (*UpdatePatchDeploymentRequest) GetUpdateMask
func (x *UpdatePatchDeploymentRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdatePatchDeploymentRequest) ProtoMessage
func (*UpdatePatchDeploymentRequest) ProtoMessage()func (*UpdatePatchDeploymentRequest) ProtoReflect
func (x *UpdatePatchDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*UpdatePatchDeploymentRequest) Reset
func (x *UpdatePatchDeploymentRequest) Reset()func (*UpdatePatchDeploymentRequest) String
func (x *UpdatePatchDeploymentRequest) String() stringWeekDayOfMonth
type WeekDayOfMonth struct {
// 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 int32 `protobuf:"varint,1,opt,name=week_ordinal,json=weekOrdinal,proto3" json:"week_ordinal,omitempty"`
// Required. A day of the week.
DayOfWeek dayofweek.DayOfWeek `protobuf:"varint,2,opt,name=day_of_week,json=dayOfWeek,proto3,enum=google.type.DayOfWeek" json:"day_of_week,omitempty"`
// 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 int32 `protobuf:"varint,3,opt,name=day_offset,json=dayOffset,proto3" json:"day_offset,omitempty"`
// contains filtered or unexported fields
}Represents one week day in a month. An example is "the 4th Sunday".
func (*WeekDayOfMonth) Descriptor
func (*WeekDayOfMonth) Descriptor() ([]byte, []int)Deprecated: Use WeekDayOfMonth.ProtoReflect.Descriptor instead.
func (*WeekDayOfMonth) GetDayOfWeek
func (x *WeekDayOfMonth) GetDayOfWeek() dayofweek.DayOfWeekfunc (*WeekDayOfMonth) GetDayOffset
func (x *WeekDayOfMonth) GetDayOffset() int32func (*WeekDayOfMonth) GetWeekOrdinal
func (x *WeekDayOfMonth) GetWeekOrdinal() int32func (*WeekDayOfMonth) ProtoMessage
func (*WeekDayOfMonth) ProtoMessage()func (*WeekDayOfMonth) ProtoReflect
func (x *WeekDayOfMonth) ProtoReflect() protoreflect.Messagefunc (*WeekDayOfMonth) Reset
func (x *WeekDayOfMonth) Reset()func (*WeekDayOfMonth) String
func (x *WeekDayOfMonth) String() stringWeeklySchedule
type WeeklySchedule struct {
// Required. Day of the week.
DayOfWeek dayofweek.DayOfWeek `protobuf:"varint,1,opt,name=day_of_week,json=dayOfWeek,proto3,enum=google.type.DayOfWeek" json:"day_of_week,omitempty"`
// contains filtered or unexported fields
}Represents a weekly schedule.
func (*WeeklySchedule) Descriptor
func (*WeeklySchedule) Descriptor() ([]byte, []int)Deprecated: Use WeeklySchedule.ProtoReflect.Descriptor instead.
func (*WeeklySchedule) GetDayOfWeek
func (x *WeeklySchedule) GetDayOfWeek() dayofweek.DayOfWeekfunc (*WeeklySchedule) ProtoMessage
func (*WeeklySchedule) ProtoMessage()func (*WeeklySchedule) ProtoReflect
func (x *WeeklySchedule) ProtoReflect() protoreflect.Messagefunc (*WeeklySchedule) Reset
func (x *WeeklySchedule) Reset()func (*WeeklySchedule) String
func (x *WeeklySchedule) String() stringWindowsUpdateSettings
type WindowsUpdateSettings struct {
// Only apply updates of these windows update classifications. If empty, all
// updates are applied.
Classifications []WindowsUpdateSettings_Classification `protobuf:"varint,1,rep,packed,name=classifications,proto3,enum=google.cloud.osconfig.v1beta.WindowsUpdateSettings_Classification" json:"classifications,omitempty"`
// List of KBs to exclude from update.
Excludes []string `protobuf:"bytes,2,rep,name=excludes,proto3" json:"excludes,omitempty"`
// 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 `protobuf:"bytes,3,rep,name=exclusive_patches,json=exclusivePatches,proto3" json:"exclusive_patches,omitempty"`
// contains filtered or unexported fields
}Windows patching is performed using the Windows Update Agent.
func (*WindowsUpdateSettings) Descriptor
func (*WindowsUpdateSettings) Descriptor() ([]byte, []int)Deprecated: Use WindowsUpdateSettings.ProtoReflect.Descriptor instead.
func (*WindowsUpdateSettings) GetClassifications
func (x *WindowsUpdateSettings) GetClassifications() []WindowsUpdateSettings_Classificationfunc (*WindowsUpdateSettings) GetExcludes
func (x *WindowsUpdateSettings) GetExcludes() []stringfunc (*WindowsUpdateSettings) GetExclusivePatches
func (x *WindowsUpdateSettings) GetExclusivePatches() []stringfunc (*WindowsUpdateSettings) ProtoMessage
func (*WindowsUpdateSettings) ProtoMessage()func (*WindowsUpdateSettings) ProtoReflect
func (x *WindowsUpdateSettings) ProtoReflect() protoreflect.Messagefunc (*WindowsUpdateSettings) Reset
func (x *WindowsUpdateSettings) Reset()func (*WindowsUpdateSettings) String
func (x *WindowsUpdateSettings) String() stringWindowsUpdateSettings_Classification
type WindowsUpdateSettings_Classification int32Microsoft Windows update classifications as defined in [1] https://support.microsoft.com/en-us/help/824684/description-of-the-standard-terminology-that-is-used-to-describe-micro
WindowsUpdateSettings_CLASSIFICATION_UNSPECIFIED, WindowsUpdateSettings_CRITICAL, WindowsUpdateSettings_SECURITY, WindowsUpdateSettings_DEFINITION, WindowsUpdateSettings_DRIVER, WindowsUpdateSettings_FEATURE_PACK, WindowsUpdateSettings_SERVICE_PACK, WindowsUpdateSettings_TOOL, WindowsUpdateSettings_UPDATE_ROLLUP, WindowsUpdateSettings_UPDATE
const (
// Invalid. If classifications are included, they must be specified.
WindowsUpdateSettings_CLASSIFICATION_UNSPECIFIED WindowsUpdateSettings_Classification = 0
// "A widely released fix for a specific problem that addresses a critical,
// non-security-related bug." [1]
WindowsUpdateSettings_CRITICAL WindowsUpdateSettings_Classification = 1
// "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]
WindowsUpdateSettings_SECURITY WindowsUpdateSettings_Classification = 2
// "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]
WindowsUpdateSettings_DEFINITION WindowsUpdateSettings_Classification = 3
// "Software that controls the input and output of a device." [1]
WindowsUpdateSettings_DRIVER WindowsUpdateSettings_Classification = 4
// "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]
WindowsUpdateSettings_FEATURE_PACK WindowsUpdateSettings_Classification = 5
// "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]
WindowsUpdateSettings_SERVICE_PACK WindowsUpdateSettings_Classification = 6
// "A utility or feature that helps complete a task or set of tasks." [1]
WindowsUpdateSettings_TOOL WindowsUpdateSettings_Classification = 7
// "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]
WindowsUpdateSettings_UPDATE_ROLLUP WindowsUpdateSettings_Classification = 8
// "A widely released fix for a specific problem. An update addresses a
// noncritical, non-security-related bug." [1]
WindowsUpdateSettings_UPDATE WindowsUpdateSettings_Classification = 9
)func (WindowsUpdateSettings_Classification) Descriptor
func (WindowsUpdateSettings_Classification) Descriptor() protoreflect.EnumDescriptorfunc (WindowsUpdateSettings_Classification) Enum
func (x WindowsUpdateSettings_Classification) Enum() *WindowsUpdateSettings_Classificationfunc (WindowsUpdateSettings_Classification) EnumDescriptor
func (WindowsUpdateSettings_Classification) EnumDescriptor() ([]byte, []int)Deprecated: Use WindowsUpdateSettings_Classification.Descriptor instead.
func (WindowsUpdateSettings_Classification) Number
func (x WindowsUpdateSettings_Classification) Number() protoreflect.EnumNumberfunc (WindowsUpdateSettings_Classification) String
func (x WindowsUpdateSettings_Classification) String() stringfunc (WindowsUpdateSettings_Classification) Type
func (WindowsUpdateSettings_Classification) Type() protoreflect.EnumTypeYumRepository
type YumRepository struct {
// 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 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The display name of the repository.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The location of the repository directory.
BaseUrl string `protobuf:"bytes,3,opt,name=base_url,json=baseUrl,proto3" json:"base_url,omitempty"`
// URIs of GPG keys.
GpgKeys []string `protobuf:"bytes,4,rep,name=gpg_keys,json=gpgKeys,proto3" json:"gpg_keys,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*YumRepository) Descriptor() ([]byte, []int)Deprecated: Use YumRepository.ProtoReflect.Descriptor instead.
func (*YumRepository) GetBaseUrl
func (x *YumRepository) GetBaseUrl() stringfunc (*YumRepository) GetDisplayName
func (x *YumRepository) GetDisplayName() stringfunc (*YumRepository) GetGpgKeys
func (x *YumRepository) GetGpgKeys() []stringfunc (*YumRepository) GetId
func (x *YumRepository) GetId() stringfunc (*YumRepository) ProtoMessage
func (*YumRepository) ProtoMessage()func (*YumRepository) ProtoReflect
func (x *YumRepository) ProtoReflect() protoreflect.Messagefunc (*YumRepository) Reset
func (x *YumRepository) Reset()func (*YumRepository) String
func (x *YumRepository) String() stringYumSettings
type YumSettings struct {
// Adds the `--security` flag to `yum update`. Not supported on
// all platforms.
Security bool `protobuf:"varint,1,opt,name=security,proto3" json:"security,omitempty"`
// Will cause patch to run `yum update-minimal` instead.
Minimal bool `protobuf:"varint,2,opt,name=minimal,proto3" json:"minimal,omitempty"`
// List of packages to exclude from update. These packages are excluded by
// using the yum `--exclude` flag.
Excludes []string `protobuf:"bytes,3,rep,name=excludes,proto3" json:"excludes,omitempty"`
// 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 `protobuf:"bytes,4,rep,name=exclusive_packages,json=exclusivePackages,proto3" json:"exclusive_packages,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*YumSettings) Descriptor() ([]byte, []int)Deprecated: Use YumSettings.ProtoReflect.Descriptor instead.
func (*YumSettings) GetExcludes
func (x *YumSettings) GetExcludes() []stringfunc (*YumSettings) GetExclusivePackages
func (x *YumSettings) GetExclusivePackages() []stringfunc (*YumSettings) GetMinimal
func (x *YumSettings) GetMinimal() boolfunc (*YumSettings) GetSecurity
func (x *YumSettings) GetSecurity() boolfunc (*YumSettings) ProtoMessage
func (*YumSettings) ProtoMessage()func (*YumSettings) ProtoReflect
func (x *YumSettings) ProtoReflect() protoreflect.Messagefunc (*YumSettings) Reset
func (x *YumSettings) Reset()func (*YumSettings) String
func (x *YumSettings) String() stringZypperRepository
type ZypperRepository struct {
// 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 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The display name of the repository.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The location of the repository directory.
BaseUrl string `protobuf:"bytes,3,opt,name=base_url,json=baseUrl,proto3" json:"base_url,omitempty"`
// URIs of GPG keys.
GpgKeys []string `protobuf:"bytes,4,rep,name=gpg_keys,json=gpgKeys,proto3" json:"gpg_keys,omitempty"`
// contains filtered or unexported fields
}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) Descriptor
func (*ZypperRepository) Descriptor() ([]byte, []int)Deprecated: Use ZypperRepository.ProtoReflect.Descriptor instead.
func (*ZypperRepository) GetBaseUrl
func (x *ZypperRepository) GetBaseUrl() stringfunc (*ZypperRepository) GetDisplayName
func (x *ZypperRepository) GetDisplayName() stringfunc (*ZypperRepository) GetGpgKeys
func (x *ZypperRepository) GetGpgKeys() []stringfunc (*ZypperRepository) GetId
func (x *ZypperRepository) GetId() stringfunc (*ZypperRepository) ProtoMessage
func (*ZypperRepository) ProtoMessage()func (*ZypperRepository) ProtoReflect
func (x *ZypperRepository) ProtoReflect() protoreflect.Messagefunc (*ZypperRepository) Reset
func (x *ZypperRepository) Reset()func (*ZypperRepository) String
func (x *ZypperRepository) String() stringZypperSettings
type ZypperSettings struct {
// Adds the `--with-optional` flag to `zypper patch`.
WithOptional bool `protobuf:"varint,1,opt,name=with_optional,json=withOptional,proto3" json:"with_optional,omitempty"`
// Adds the `--with-update` flag, to `zypper patch`.
WithUpdate bool `protobuf:"varint,2,opt,name=with_update,json=withUpdate,proto3" json:"with_update,omitempty"`
// Install only patches with these categories.
// Common categories include security, recommended, and feature.
Categories []string `protobuf:"bytes,3,rep,name=categories,proto3" json:"categories,omitempty"`
// Install only patches with these severities.
// Common severities include critical, important, moderate, and low.
Severities []string `protobuf:"bytes,4,rep,name=severities,proto3" json:"severities,omitempty"`
// List of patches to exclude from update.
Excludes []string `protobuf:"bytes,5,rep,name=excludes,proto3" json:"excludes,omitempty"`
// An exclusive list of patches to be updated. These are the only patches
// that will be installed using 'zypper patch patch:Zypper patching is performed by running zypper patch.
See also https://en.opensuse.org/SDB:Zypper_manual.
func (*ZypperSettings) Descriptor
func (*ZypperSettings) Descriptor() ([]byte, []int)Deprecated: Use ZypperSettings.ProtoReflect.Descriptor instead.
func (*ZypperSettings) GetCategories
func (x *ZypperSettings) GetCategories() []stringfunc (*ZypperSettings) GetExcludes
func (x *ZypperSettings) GetExcludes() []stringfunc (*ZypperSettings) GetExclusivePatches
func (x *ZypperSettings) GetExclusivePatches() []stringfunc (*ZypperSettings) GetSeverities
func (x *ZypperSettings) GetSeverities() []stringfunc (*ZypperSettings) GetWithOptional
func (x *ZypperSettings) GetWithOptional() boolfunc (*ZypperSettings) GetWithUpdate
func (x *ZypperSettings) GetWithUpdate() boolfunc (*ZypperSettings) ProtoMessage
func (*ZypperSettings) ProtoMessage()func (*ZypperSettings) ProtoReflect
func (x *ZypperSettings) ProtoReflect() protoreflect.Messagefunc (*ZypperSettings) Reset
func (x *ZypperSettings) Reset()func (*ZypperSettings) String
func (x *ZypperSettings) String() string