Constants
AgentEndpointService_ReceiveTaskNotification_FullMethodName, AgentEndpointService_StartNextTask_FullMethodName, AgentEndpointService_ReportTaskProgress_FullMethodName, AgentEndpointService_ReportTaskComplete_FullMethodName, AgentEndpointService_LookupEffectiveGuestPolicy_FullMethodName, AgentEndpointService_RegisterAgent_FullMethodName
const (
AgentEndpointService_ReceiveTaskNotification_FullMethodName = "/google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService/ReceiveTaskNotification"
AgentEndpointService_StartNextTask_FullMethodName = "/google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService/StartNextTask"
AgentEndpointService_ReportTaskProgress_FullMethodName = "/google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService/ReportTaskProgress"
AgentEndpointService_ReportTaskComplete_FullMethodName = "/google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService/ReportTaskComplete"
AgentEndpointService_LookupEffectiveGuestPolicy_FullMethodName = "/google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService/LookupEffectiveGuestPolicy"
AgentEndpointService_RegisterAgent_FullMethodName = "/google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService/RegisterAgent"
)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.
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.
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",
3: "NONE",
1: "SHELL",
2: "POWERSHELL",
}
ExecStepConfig_Interpreter_value = map[string]int32{
"INTERPRETER_UNSPECIFIED": 0,
"NONE": 3,
"SHELL": 1,
"POWERSHELL": 2,
}
)Enum value maps for ExecStepConfig_Interpreter.
TaskDirective_name, TaskDirective_value
var (
TaskDirective_name = map[int32]string{
0: "TASK_DIRECTIVE_UNSPECIFIED",
1: "CONTINUE",
2: "STOP",
}
TaskDirective_value = map[string]int32{
"TASK_DIRECTIVE_UNSPECIFIED": 0,
"CONTINUE": 1,
"STOP": 2,
}
)Enum value maps for TaskDirective.
TaskType_name, TaskType_value
var (
TaskType_name = map[int32]string{
0: "TASK_TYPE_UNSPECIFIED",
1: "APPLY_PATCHES",
2: "EXEC_STEP_TASK",
}
TaskType_value = map[string]int32{
"TASK_TYPE_UNSPECIFIED": 0,
"APPLY_PATCHES": 1,
"EXEC_STEP_TASK": 2,
}
)Enum value maps for TaskType.
ApplyPatchesTaskProgress_State_name, ApplyPatchesTaskProgress_State_value
var (
ApplyPatchesTaskProgress_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
4: "STARTED",
1: "DOWNLOADING_PATCHES",
2: "APPLYING_PATCHES",
3: "REBOOTING",
}
ApplyPatchesTaskProgress_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTED": 4,
"DOWNLOADING_PATCHES": 1,
"APPLYING_PATCHES": 2,
"REBOOTING": 3,
}
)Enum value maps for ApplyPatchesTaskProgress_State.
ApplyPatchesTaskOutput_State_name, ApplyPatchesTaskOutput_State_value
var (
ApplyPatchesTaskOutput_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "SUCCEEDED",
2: "SUCCEEDED_REBOOT_REQUIRED",
3: "FAILED",
}
ApplyPatchesTaskOutput_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"SUCCEEDED": 1,
"SUCCEEDED_REBOOT_REQUIRED": 2,
"FAILED": 3,
}
)Enum value maps for ApplyPatchesTaskOutput_State.
ExecStepTaskProgress_State_name, ExecStepTaskProgress_State_value
var (
ExecStepTaskProgress_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "STARTED",
}
ExecStepTaskProgress_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTED": 1,
}
)Enum value maps for ExecStepTaskProgress_State.
ExecStepTaskOutput_State_name, ExecStepTaskOutput_State_value
var (
ExecStepTaskOutput_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "COMPLETED",
2: "TIMED_OUT",
3: "CANCELLED",
}
ExecStepTaskOutput_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"COMPLETED": 1,
"TIMED_OUT": 2,
"CANCELLED": 3,
}
)Enum value maps for ExecStepTaskOutput_State.
AgentEndpointService_ServiceDesc
var AgentEndpointService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.osconfig.agentendpoint.v1beta.AgentEndpointService",
HandlerType: (*AgentEndpointServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "StartNextTask",
Handler: _AgentEndpointService_StartNextTask_Handler,
},
{
MethodName: "ReportTaskProgress",
Handler: _AgentEndpointService_ReportTaskProgress_Handler,
},
{
MethodName: "ReportTaskComplete",
Handler: _AgentEndpointService_ReportTaskComplete_Handler,
},
{
MethodName: "LookupEffectiveGuestPolicy",
Handler: _AgentEndpointService_LookupEffectiveGuestPolicy_Handler,
},
{
MethodName: "RegisterAgent",
Handler: _AgentEndpointService_RegisterAgent_Handler,
},
},
Streams: []grpc.StreamDesc{
{
StreamName: "ReceiveTaskNotification",
Handler: _AgentEndpointService_ReceiveTaskNotification_Handler,
ServerStreams: true,
},
},
Metadata: "google/cloud/osconfig/agentendpoint/v1beta/agentendpoint.proto",
}AgentEndpointService_ServiceDesc is the grpc.ServiceDesc for AgentEndpointService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_osconfig_agentendpoint_v1beta_agentendpoint_proto
var File_google_cloud_osconfig_agentendpoint_v1beta_agentendpoint_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_agentendpoint_v1beta_guest_policies_proto
var File_google_cloud_osconfig_agentendpoint_v1beta_guest_policies_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_agentendpoint_v1beta_patch_jobs_proto
var File_google_cloud_osconfig_agentendpoint_v1beta_patch_jobs_proto protoreflect.FileDescriptorFile_google_cloud_osconfig_agentendpoint_v1beta_tasks_proto
var File_google_cloud_osconfig_agentendpoint_v1beta_tasks_proto protoreflect.FileDescriptorFunctions
func RegisterAgentEndpointServiceServer
func RegisterAgentEndpointServiceServer(s grpc.ServiceRegistrar, srv AgentEndpointServiceServer)AgentEndpointServiceClient
type AgentEndpointServiceClient interface {
// Stream established by client to receive Task notifications.
ReceiveTaskNotification(ctx context.Context, in *ReceiveTaskNotificationRequest, opts ...grpc.CallOption) (AgentEndpointService_ReceiveTaskNotificationClient, error)
// Signals the start of a task execution and returns the task info.
StartNextTask(ctx context.Context, in *StartNextTaskRequest, opts ...grpc.CallOption) (*StartNextTaskResponse, error)
// Signals an intermediary progress checkpoint in task execution.
ReportTaskProgress(ctx context.Context, in *ReportTaskProgressRequest, opts ...grpc.CallOption) (*ReportTaskProgressResponse, error)
// Signals that the task execution is complete and optionally returns the next
// task.
ReportTaskComplete(ctx context.Context, in *ReportTaskCompleteRequest, opts ...grpc.CallOption) (*ReportTaskCompleteResponse, 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)
// Registers the agent running on the VM.
RegisterAgent(ctx context.Context, in *RegisterAgentRequest, opts ...grpc.CallOption) (*RegisterAgentResponse, error)
}AgentEndpointServiceClient is the client API for AgentEndpointService 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 NewAgentEndpointServiceClient
func NewAgentEndpointServiceClient(cc grpc.ClientConnInterface) AgentEndpointServiceClientAgentEndpointServiceServer
type AgentEndpointServiceServer interface {
// Stream established by client to receive Task notifications.
ReceiveTaskNotification(*ReceiveTaskNotificationRequest, AgentEndpointService_ReceiveTaskNotificationServer) error
// Signals the start of a task execution and returns the task info.
StartNextTask(context.Context, *StartNextTaskRequest) (*StartNextTaskResponse, error)
// Signals an intermediary progress checkpoint in task execution.
ReportTaskProgress(context.Context, *ReportTaskProgressRequest) (*ReportTaskProgressResponse, error)
// Signals that the task execution is complete and optionally returns the next
// task.
ReportTaskComplete(context.Context, *ReportTaskCompleteRequest) (*ReportTaskCompleteResponse, 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)
// Registers the agent running on the VM.
RegisterAgent(context.Context, *RegisterAgentRequest) (*RegisterAgentResponse, error)
}AgentEndpointServiceServer is the server API for AgentEndpointService service. All implementations should embed UnimplementedAgentEndpointServiceServer for forward compatibility
AgentEndpointService_ReceiveTaskNotificationClient
type AgentEndpointService_ReceiveTaskNotificationClient interface {
Recv() (*ReceiveTaskNotificationResponse, error)
grpc.ClientStream
}AgentEndpointService_ReceiveTaskNotificationServer
type AgentEndpointService_ReceiveTaskNotificationServer interface {
Send(*ReceiveTaskNotificationResponse) error
grpc.ServerStream
}ApplyPatchesTask
type ApplyPatchesTask struct {
// Specific information about how patches should be applied.
PatchConfig *PatchConfig `protobuf:"bytes,1,opt,name=patch_config,json=patchConfig,proto3" json:"patch_config,omitempty"`
// If true, the agent will report its status as it goes through the motions
// but won't actually run any updates or perform any reboots.
DryRun bool `protobuf:"varint,3,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
// contains filtered or unexported fields
}Message which instructs agent to apply patches.
func (*ApplyPatchesTask) Descriptor
func (*ApplyPatchesTask) Descriptor() ([]byte, []int)Deprecated: Use ApplyPatchesTask.ProtoReflect.Descriptor instead.
func (*ApplyPatchesTask) GetDryRun
func (x *ApplyPatchesTask) GetDryRun() boolfunc (*ApplyPatchesTask) GetPatchConfig
func (x *ApplyPatchesTask) GetPatchConfig() *PatchConfigfunc (*ApplyPatchesTask) ProtoMessage
func (*ApplyPatchesTask) ProtoMessage()func (*ApplyPatchesTask) ProtoReflect
func (x *ApplyPatchesTask) ProtoReflect() protoreflect.Messagefunc (*ApplyPatchesTask) Reset
func (x *ApplyPatchesTask) Reset()func (*ApplyPatchesTask) String
func (x *ApplyPatchesTask) String() stringApplyPatchesTaskOutput
type ApplyPatchesTaskOutput struct {
// Required. The final state of this task.
State ApplyPatchesTaskOutput_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.ApplyPatchesTaskOutput_State" json:"state,omitempty"`
// contains filtered or unexported fields
}Information reported from the agent about applying patches execution.
func (*ApplyPatchesTaskOutput) Descriptor
func (*ApplyPatchesTaskOutput) Descriptor() ([]byte, []int)Deprecated: Use ApplyPatchesTaskOutput.ProtoReflect.Descriptor instead.
func (*ApplyPatchesTaskOutput) GetState
func (x *ApplyPatchesTaskOutput) GetState() ApplyPatchesTaskOutput_Statefunc (*ApplyPatchesTaskOutput) ProtoMessage
func (*ApplyPatchesTaskOutput) ProtoMessage()func (*ApplyPatchesTaskOutput) ProtoReflect
func (x *ApplyPatchesTaskOutput) ProtoReflect() protoreflect.Messagefunc (*ApplyPatchesTaskOutput) Reset
func (x *ApplyPatchesTaskOutput) Reset()func (*ApplyPatchesTaskOutput) String
func (x *ApplyPatchesTaskOutput) String() stringApplyPatchesTaskOutput_State
type ApplyPatchesTaskOutput_State int32The final states of applying patches.
ApplyPatchesTaskOutput_STATE_UNSPECIFIED, ApplyPatchesTaskOutput_SUCCEEDED, ApplyPatchesTaskOutput_SUCCEEDED_REBOOT_REQUIRED, ApplyPatchesTaskOutput_FAILED
const (
// Unspecified is invalid.
ApplyPatchesTaskOutput_STATE_UNSPECIFIED ApplyPatchesTaskOutput_State = 0
// Applying patches completed successfully.
ApplyPatchesTaskOutput_SUCCEEDED ApplyPatchesTaskOutput_State = 1
// Applying patches completed successfully, but a reboot is required.
ApplyPatchesTaskOutput_SUCCEEDED_REBOOT_REQUIRED ApplyPatchesTaskOutput_State = 2
// Applying patches failed.
ApplyPatchesTaskOutput_FAILED ApplyPatchesTaskOutput_State = 3
)func (ApplyPatchesTaskOutput_State) Descriptor
func (ApplyPatchesTaskOutput_State) Descriptor() protoreflect.EnumDescriptorfunc (ApplyPatchesTaskOutput_State) Enum
func (x ApplyPatchesTaskOutput_State) Enum() *ApplyPatchesTaskOutput_Statefunc (ApplyPatchesTaskOutput_State) EnumDescriptor
func (ApplyPatchesTaskOutput_State) EnumDescriptor() ([]byte, []int)Deprecated: Use ApplyPatchesTaskOutput_State.Descriptor instead.
func (ApplyPatchesTaskOutput_State) Number
func (x ApplyPatchesTaskOutput_State) Number() protoreflect.EnumNumberfunc (ApplyPatchesTaskOutput_State) String
func (x ApplyPatchesTaskOutput_State) String() stringfunc (ApplyPatchesTaskOutput_State) Type
func (ApplyPatchesTaskOutput_State) Type() protoreflect.EnumTypeApplyPatchesTaskProgress
type ApplyPatchesTaskProgress struct {
// Required. The current state of this patch execution.
State ApplyPatchesTaskProgress_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.ApplyPatchesTaskProgress_State" json:"state,omitempty"`
// contains filtered or unexported fields
}Information reported from the agent about applying patches execution.
func (*ApplyPatchesTaskProgress) Descriptor
func (*ApplyPatchesTaskProgress) Descriptor() ([]byte, []int)Deprecated: Use ApplyPatchesTaskProgress.ProtoReflect.Descriptor instead.
func (*ApplyPatchesTaskProgress) GetState
func (x *ApplyPatchesTaskProgress) GetState() ApplyPatchesTaskProgress_Statefunc (*ApplyPatchesTaskProgress) ProtoMessage
func (*ApplyPatchesTaskProgress) ProtoMessage()func (*ApplyPatchesTaskProgress) ProtoReflect
func (x *ApplyPatchesTaskProgress) ProtoReflect() protoreflect.Messagefunc (*ApplyPatchesTaskProgress) Reset
func (x *ApplyPatchesTaskProgress) Reset()func (*ApplyPatchesTaskProgress) String
func (x *ApplyPatchesTaskProgress) String() stringApplyPatchesTaskProgress_State
type ApplyPatchesTaskProgress_State int32The intermediate states of applying patches.
ApplyPatchesTaskProgress_STATE_UNSPECIFIED, ApplyPatchesTaskProgress_STARTED, ApplyPatchesTaskProgress_DOWNLOADING_PATCHES, ApplyPatchesTaskProgress_APPLYING_PATCHES, ApplyPatchesTaskProgress_REBOOTING
const (
// Unspecified is invalid.
ApplyPatchesTaskProgress_STATE_UNSPECIFIED ApplyPatchesTaskProgress_State = 0
// The agent has started the patch task.
ApplyPatchesTaskProgress_STARTED ApplyPatchesTaskProgress_State = 4
// The agent is currently downloading patches.
ApplyPatchesTaskProgress_DOWNLOADING_PATCHES ApplyPatchesTaskProgress_State = 1
// The agent is currently applying patches.
ApplyPatchesTaskProgress_APPLYING_PATCHES ApplyPatchesTaskProgress_State = 2
// The agent is currently rebooting the VM instance.
ApplyPatchesTaskProgress_REBOOTING ApplyPatchesTaskProgress_State = 3
)func (ApplyPatchesTaskProgress_State) Descriptor
func (ApplyPatchesTaskProgress_State) Descriptor() protoreflect.EnumDescriptorfunc (ApplyPatchesTaskProgress_State) Enum
func (x ApplyPatchesTaskProgress_State) Enum() *ApplyPatchesTaskProgress_Statefunc (ApplyPatchesTaskProgress_State) EnumDescriptor
func (ApplyPatchesTaskProgress_State) EnumDescriptor() ([]byte, []int)Deprecated: Use ApplyPatchesTaskProgress_State.Descriptor instead.
func (ApplyPatchesTaskProgress_State) Number
func (x ApplyPatchesTaskProgress_State) Number() protoreflect.EnumNumberfunc (ApplyPatchesTaskProgress_State) String
func (x ApplyPatchesTaskProgress_State) String() stringfunc (ApplyPatchesTaskProgress_State) Type
func (ApplyPatchesTaskProgress_State) Type() protoreflect.EnumTypeAptRepository
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.agentendpoint.v1beta.AptRepository_ArchiveType" json:"archive_type,omitempty"`
// URI for this repository.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// Distribution of this repository.
Distribution string `protobuf:"bytes,3,opt,name=distribution,proto3" json:"distribution,omitempty"`
// 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 will be performed
// using `apt-get dist-upgrade` instead.
Type AptSettings_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.AptSettings_Type" json:"type,omitempty"`
// List of packages to exclude from update.
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 will be performed 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.EnumTypeDesiredState
type DesiredState int32The desired state that the OS Config agent will maintain on the VM.
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 assigned to the 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.
// [Wikipedia shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)).
Interpreter ExecStepConfig_Interpreter `protobuf:"varint,4,opt,name=interpreter,proto3,enum=google.cloud.osconfig.agentendpoint.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 GCS 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_NONE, ExecStepConfig_SHELL, ExecStepConfig_POWERSHELL
const (
// Deprecated, defaults to NONE for compatibility reasons.
ExecStepConfig_INTERPRETER_UNSPECIFIED ExecStepConfig_Interpreter = 0
// Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
// interpreter will be parsed from the shebang line of the script if
// unspecified.
ExecStepConfig_NONE ExecStepConfig_Interpreter = 3
// Indicates that the script will be run with /bin/sh on Linux and cmd
// on windows.
ExecStepConfig_SHELL ExecStepConfig_Interpreter = 1
// Indicates that the file will be run with PowerShell.
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"`
}ExecStepTask
type ExecStepTask struct {
// Details of the exec step to run.
ExecStep *ExecStep `protobuf:"bytes,1,opt,name=exec_step,json=execStep,proto3" json:"exec_step,omitempty"`
// contains filtered or unexported fields
}Message which instructs agent to execute the following command.
func (*ExecStepTask) Descriptor
func (*ExecStepTask) Descriptor() ([]byte, []int)Deprecated: Use ExecStepTask.ProtoReflect.Descriptor instead.
func (*ExecStepTask) GetExecStep
func (x *ExecStepTask) GetExecStep() *ExecStepfunc (*ExecStepTask) ProtoMessage
func (*ExecStepTask) ProtoMessage()func (*ExecStepTask) ProtoReflect
func (x *ExecStepTask) ProtoReflect() protoreflect.Messagefunc (*ExecStepTask) Reset
func (x *ExecStepTask) Reset()func (*ExecStepTask) String
func (x *ExecStepTask) String() stringExecStepTaskOutput
type ExecStepTaskOutput struct {
// Required. The final state of the exec step.
State ExecStepTaskOutput_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.ExecStepTaskOutput_State" json:"state,omitempty"`
// Required. The exit code received from the script which ran as part of the exec step.
ExitCode int32 `protobuf:"varint,2,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
// contains filtered or unexported fields
}Information reported from the agent about the exec step execution.
func (*ExecStepTaskOutput) Descriptor
func (*ExecStepTaskOutput) Descriptor() ([]byte, []int)Deprecated: Use ExecStepTaskOutput.ProtoReflect.Descriptor instead.
func (*ExecStepTaskOutput) GetExitCode
func (x *ExecStepTaskOutput) GetExitCode() int32func (*ExecStepTaskOutput) GetState
func (x *ExecStepTaskOutput) GetState() ExecStepTaskOutput_Statefunc (*ExecStepTaskOutput) ProtoMessage
func (*ExecStepTaskOutput) ProtoMessage()func (*ExecStepTaskOutput) ProtoReflect
func (x *ExecStepTaskOutput) ProtoReflect() protoreflect.Messagefunc (*ExecStepTaskOutput) Reset
func (x *ExecStepTaskOutput) Reset()func (*ExecStepTaskOutput) String
func (x *ExecStepTaskOutput) String() stringExecStepTaskOutput_State
type ExecStepTaskOutput_State int32The final states of exec steps.
ExecStepTaskOutput_STATE_UNSPECIFIED, ExecStepTaskOutput_COMPLETED, ExecStepTaskOutput_TIMED_OUT, ExecStepTaskOutput_CANCELLED
const (
// Unspecified is invalid.
ExecStepTaskOutput_STATE_UNSPECIFIED ExecStepTaskOutput_State = 0
// The exec step completed normally.
ExecStepTaskOutput_COMPLETED ExecStepTaskOutput_State = 1
// The exec step was terminated because it took too long.
ExecStepTaskOutput_TIMED_OUT ExecStepTaskOutput_State = 2
// The exec step task was cancelled before it started.
ExecStepTaskOutput_CANCELLED ExecStepTaskOutput_State = 3
)func (ExecStepTaskOutput_State) Descriptor
func (ExecStepTaskOutput_State) Descriptor() protoreflect.EnumDescriptorfunc (ExecStepTaskOutput_State) Enum
func (x ExecStepTaskOutput_State) Enum() *ExecStepTaskOutput_Statefunc (ExecStepTaskOutput_State) EnumDescriptor
func (ExecStepTaskOutput_State) EnumDescriptor() ([]byte, []int)Deprecated: Use ExecStepTaskOutput_State.Descriptor instead.
func (ExecStepTaskOutput_State) Number
func (x ExecStepTaskOutput_State) Number() protoreflect.EnumNumberfunc (ExecStepTaskOutput_State) String
func (x ExecStepTaskOutput_State) String() stringfunc (ExecStepTaskOutput_State) Type
func (ExecStepTaskOutput_State) Type() protoreflect.EnumTypeExecStepTaskProgress
type ExecStepTaskProgress struct {
// Required. The current state of this exec step.
State ExecStepTaskProgress_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.ExecStepTaskProgress_State" json:"state,omitempty"`
// contains filtered or unexported fields
}Information reported from the agent about the exec step execution.
func (*ExecStepTaskProgress) Descriptor
func (*ExecStepTaskProgress) Descriptor() ([]byte, []int)Deprecated: Use ExecStepTaskProgress.ProtoReflect.Descriptor instead.
func (*ExecStepTaskProgress) GetState
func (x *ExecStepTaskProgress) GetState() ExecStepTaskProgress_Statefunc (*ExecStepTaskProgress) ProtoMessage
func (*ExecStepTaskProgress) ProtoMessage()func (*ExecStepTaskProgress) ProtoReflect
func (x *ExecStepTaskProgress) ProtoReflect() protoreflect.Messagefunc (*ExecStepTaskProgress) Reset
func (x *ExecStepTaskProgress) Reset()func (*ExecStepTaskProgress) String
func (x *ExecStepTaskProgress) String() stringExecStepTaskProgress_State
type ExecStepTaskProgress_State int32The intermediate states of exec steps.
ExecStepTaskProgress_STATE_UNSPECIFIED, ExecStepTaskProgress_STARTED
const (
// Unspecified is invalid.
ExecStepTaskProgress_STATE_UNSPECIFIED ExecStepTaskProgress_State = 0
// The agent has started the exec step task.
ExecStepTaskProgress_STARTED ExecStepTaskProgress_State = 1
)func (ExecStepTaskProgress_State) Descriptor
func (ExecStepTaskProgress_State) Descriptor() protoreflect.EnumDescriptorfunc (ExecStepTaskProgress_State) Enum
func (x ExecStepTaskProgress_State) Enum() *ExecStepTaskProgress_Statefunc (ExecStepTaskProgress_State) EnumDescriptor
func (ExecStepTaskProgress_State) EnumDescriptor() ([]byte, []int)Deprecated: Use ExecStepTaskProgress_State.Descriptor instead.
func (ExecStepTaskProgress_State) Number
func (x ExecStepTaskProgress_State) Number() protoreflect.EnumNumberfunc (ExecStepTaskProgress_State) String
func (x ExecStepTaskProgress_State) String() stringfunc (ExecStepTaskProgress_State) Type
func (ExecStepTaskProgress_State) Type() protoreflect.EnumTypeGcsObject
type GcsObject struct {
// Bucket of the GCS object.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Name of the GCS object.
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// Generation number of the GCS 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
}GCS 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
GooRepository
type GooRepository struct {
// The name of the repository.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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() stringLookupEffectiveGuestPolicyRequest
type LookupEffectiveGuestPolicyRequest struct {
// Required. This is the GCE instance identity token described in
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,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
// provide 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
// provide 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 effective policy assigned to the instance.
func (*LookupEffectiveGuestPolicyRequest) Descriptor
func (*LookupEffectiveGuestPolicyRequest) Descriptor() ([]byte, []int)Deprecated: Use LookupEffectiveGuestPolicyRequest.ProtoReflect.Descriptor instead.
func (*LookupEffectiveGuestPolicyRequest) GetInstanceIdToken
func (x *LookupEffectiveGuestPolicyRequest) GetInstanceIdToken() 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() stringPackage
type Package struct {
// 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.agentendpoint.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.agentendpoint.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.agentendpoint.v1beta.PatchConfig_RebootConfig" json:"reboot_config,omitempty"`
// Retry strategy can be defined to have the agent retry patching
// during the window if patching fails. If omitted, the agent will use its
// default retry strategy.
RetryStrategy *RetryStrategy `protobuf:"bytes,2,opt,name=retry_strategy,json=retryStrategy,proto3" json:"retry_strategy,omitempty"`
// Apt update settings. Use this override the default apt patch rules.
Apt *AptSettings `protobuf:"bytes,3,opt,name=apt,proto3" json:"apt,omitempty"`
// Yum update settings. Use this override the default yum patch rules.
Yum *YumSettings `protobuf:"bytes,4,opt,name=yum,proto3" json:"yum,omitempty"`
// Goo update settings. Use this override the default goo patch rules.
Goo *GooSettings `protobuf:"bytes,5,opt,name=goo,proto3" json:"goo,omitempty"`
// Zypper update settings. Use this 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 patches 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) GetRetryStrategy
func (x *PatchConfig) GetRetryStrategy() *RetryStrategyfunc (*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.EnumTypeReceiveTaskNotificationRequest
type ReceiveTaskNotificationRequest struct {
// Required. This is the Compute Engine instance identity token described in
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`
// Required. The version of the agent making the request.
AgentVersion string `protobuf:"bytes,2,opt,name=agent_version,json=agentVersion,proto3" json:"agent_version,omitempty"`
// contains filtered or unexported fields
}A request message to receive task notifications.
func (*ReceiveTaskNotificationRequest) Descriptor
func (*ReceiveTaskNotificationRequest) Descriptor() ([]byte, []int)Deprecated: Use ReceiveTaskNotificationRequest.ProtoReflect.Descriptor instead.
func (*ReceiveTaskNotificationRequest) GetAgentVersion
func (x *ReceiveTaskNotificationRequest) GetAgentVersion() stringfunc (*ReceiveTaskNotificationRequest) GetInstanceIdToken
func (x *ReceiveTaskNotificationRequest) GetInstanceIdToken() stringfunc (*ReceiveTaskNotificationRequest) ProtoMessage
func (*ReceiveTaskNotificationRequest) ProtoMessage()func (*ReceiveTaskNotificationRequest) ProtoReflect
func (x *ReceiveTaskNotificationRequest) ProtoReflect() protoreflect.Messagefunc (*ReceiveTaskNotificationRequest) Reset
func (x *ReceiveTaskNotificationRequest) Reset()func (*ReceiveTaskNotificationRequest) String
func (x *ReceiveTaskNotificationRequest) String() stringReceiveTaskNotificationResponse
type ReceiveTaskNotificationResponse struct {
// contains filtered or unexported fields
}The streaming rpc message that notifies the agent when it has a task that it needs to perform on the VM instance.
func (*ReceiveTaskNotificationResponse) Descriptor
func (*ReceiveTaskNotificationResponse) Descriptor() ([]byte, []int)Deprecated: Use ReceiveTaskNotificationResponse.ProtoReflect.Descriptor instead.
func (*ReceiveTaskNotificationResponse) ProtoMessage
func (*ReceiveTaskNotificationResponse) ProtoMessage()func (*ReceiveTaskNotificationResponse) ProtoReflect
func (x *ReceiveTaskNotificationResponse) ProtoReflect() protoreflect.Messagefunc (*ReceiveTaskNotificationResponse) Reset
func (x *ReceiveTaskNotificationResponse) Reset()func (*ReceiveTaskNotificationResponse) String
func (x *ReceiveTaskNotificationResponse) String() stringRegisterAgentRequest
type RegisterAgentRequest struct {
// Required. This is the Compute Engine instance identity token described in
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`
// Required. The version of the agent.
AgentVersion string `protobuf:"bytes,2,opt,name=agent_version,json=agentVersion,proto3" json:"agent_version,omitempty"`
// Required. The capabilities supported by the agent. Supported values are:
// PATCH_GA
// GUEST_POLICY_BETA
// CONFIG_V1
SupportedCapabilities []string `protobuf:"bytes,3,rep,name=supported_capabilities,json=supportedCapabilities,proto3" json:"supported_capabilities,omitempty"`
// The operating system long name.
// For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019
// Datacenter'.
OsLongName string `protobuf:"bytes,4,opt,name=os_long_name,json=osLongName,proto3" json:"os_long_name,omitempty"`
// The operating system short name.
// For example, 'windows' or 'debian'.
OsShortName string `protobuf:"bytes,5,opt,name=os_short_name,json=osShortName,proto3" json:"os_short_name,omitempty"`
// The version of the operating system.
OsVersion string `protobuf:"bytes,6,opt,name=os_version,json=osVersion,proto3" json:"os_version,omitempty"`
// The system architecture of the operating system.
OsArchitecture string `protobuf:"bytes,7,opt,name=os_architecture,json=osArchitecture,proto3" json:"os_architecture,omitempty"`
// contains filtered or unexported fields
}The request message for registering the agent.
func (*RegisterAgentRequest) Descriptor
func (*RegisterAgentRequest) Descriptor() ([]byte, []int)Deprecated: Use RegisterAgentRequest.ProtoReflect.Descriptor instead.
func (*RegisterAgentRequest) GetAgentVersion
func (x *RegisterAgentRequest) GetAgentVersion() stringfunc (*RegisterAgentRequest) GetInstanceIdToken
func (x *RegisterAgentRequest) GetInstanceIdToken() stringfunc (*RegisterAgentRequest) GetOsArchitecture
func (x *RegisterAgentRequest) GetOsArchitecture() stringfunc (*RegisterAgentRequest) GetOsLongName
func (x *RegisterAgentRequest) GetOsLongName() stringfunc (*RegisterAgentRequest) GetOsShortName
func (x *RegisterAgentRequest) GetOsShortName() stringfunc (*RegisterAgentRequest) GetOsVersion
func (x *RegisterAgentRequest) GetOsVersion() stringfunc (*RegisterAgentRequest) GetSupportedCapabilities
func (x *RegisterAgentRequest) GetSupportedCapabilities() []stringfunc (*RegisterAgentRequest) ProtoMessage
func (*RegisterAgentRequest) ProtoMessage()func (*RegisterAgentRequest) ProtoReflect
func (x *RegisterAgentRequest) ProtoReflect() protoreflect.Messagefunc (*RegisterAgentRequest) Reset
func (x *RegisterAgentRequest) Reset()func (*RegisterAgentRequest) String
func (x *RegisterAgentRequest) String() stringRegisterAgentResponse
type RegisterAgentResponse struct {
// contains filtered or unexported fields
}The response message after the agent registered.
func (*RegisterAgentResponse) Descriptor
func (*RegisterAgentResponse) Descriptor() ([]byte, []int)Deprecated: Use RegisterAgentResponse.ProtoReflect.Descriptor instead.
func (*RegisterAgentResponse) ProtoMessage
func (*RegisterAgentResponse) ProtoMessage()func (*RegisterAgentResponse) ProtoReflect
func (x *RegisterAgentResponse) ProtoReflect() protoreflect.Messagefunc (*RegisterAgentResponse) Reset
func (x *RegisterAgentResponse) Reset()func (*RegisterAgentResponse) String
func (x *RegisterAgentResponse) String() stringReportTaskCompleteRequest
type ReportTaskCompleteRequest struct {
// Required. This is the Compute Engine instance identity token described in
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`
// Required. Unique identifier of the task this applies to.
TaskId string `protobuf:"bytes,2,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
// Required. The type of task to report completed.
//
// The output must include the appropriate message based on the following
// enum values:
// APPLY_PATCHES = ApplyPatchesTaskOutput
// EXEC_STEP = ExecStepTaskOutput
// APPLY_CONFIG_TASK = ApplyConfigTaskOutput
TaskType TaskType `protobuf:"varint,3,opt,name=task_type,json=taskType,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.TaskType" json:"task_type,omitempty"`
// Descriptive error message if the task execution ended in error.
ErrorMessage string `protobuf:"bytes,4,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// Final output details of the current task.
//
// Types that are assignable to Output:
//
// *ReportTaskCompleteRequest_ApplyPatchesTaskOutput
// *ReportTaskCompleteRequest_ExecStepTaskOutput
Output isReportTaskCompleteRequest_Output `protobuf_oneof:"output"`
// contains filtered or unexported fields
}A request message for signaling the completion of a task execution.
func (*ReportTaskCompleteRequest) Descriptor
func (*ReportTaskCompleteRequest) Descriptor() ([]byte, []int)Deprecated: Use ReportTaskCompleteRequest.ProtoReflect.Descriptor instead.
func (*ReportTaskCompleteRequest) GetApplyPatchesTaskOutput
func (x *ReportTaskCompleteRequest) GetApplyPatchesTaskOutput() *ApplyPatchesTaskOutputfunc (*ReportTaskCompleteRequest) GetErrorMessage
func (x *ReportTaskCompleteRequest) GetErrorMessage() stringfunc (*ReportTaskCompleteRequest) GetExecStepTaskOutput
func (x *ReportTaskCompleteRequest) GetExecStepTaskOutput() *ExecStepTaskOutputfunc (*ReportTaskCompleteRequest) GetInstanceIdToken
func (x *ReportTaskCompleteRequest) GetInstanceIdToken() stringfunc (*ReportTaskCompleteRequest) GetOutput
func (m *ReportTaskCompleteRequest) GetOutput() isReportTaskCompleteRequest_Outputfunc (*ReportTaskCompleteRequest) GetTaskId
func (x *ReportTaskCompleteRequest) GetTaskId() stringfunc (*ReportTaskCompleteRequest) GetTaskType
func (x *ReportTaskCompleteRequest) GetTaskType() TaskTypefunc (*ReportTaskCompleteRequest) ProtoMessage
func (*ReportTaskCompleteRequest) ProtoMessage()func (*ReportTaskCompleteRequest) ProtoReflect
func (x *ReportTaskCompleteRequest) ProtoReflect() protoreflect.Messagefunc (*ReportTaskCompleteRequest) Reset
func (x *ReportTaskCompleteRequest) Reset()func (*ReportTaskCompleteRequest) String
func (x *ReportTaskCompleteRequest) String() stringReportTaskCompleteRequest_ApplyPatchesTaskOutput
type ReportTaskCompleteRequest_ApplyPatchesTaskOutput struct {
// Final output details of the apply patches task;
ApplyPatchesTaskOutput *ApplyPatchesTaskOutput `protobuf:"bytes,5,opt,name=apply_patches_task_output,json=applyPatchesTaskOutput,proto3,oneof"`
}ReportTaskCompleteRequest_ExecStepTaskOutput
type ReportTaskCompleteRequest_ExecStepTaskOutput struct {
// Final output details of the exec step task;
ExecStepTaskOutput *ExecStepTaskOutput `protobuf:"bytes,6,opt,name=exec_step_task_output,json=execStepTaskOutput,proto3,oneof"`
}ReportTaskCompleteResponse
type ReportTaskCompleteResponse struct {
// contains filtered or unexported fields
}The response message after the agent signaled the current task complete.
func (*ReportTaskCompleteResponse) Descriptor
func (*ReportTaskCompleteResponse) Descriptor() ([]byte, []int)Deprecated: Use ReportTaskCompleteResponse.ProtoReflect.Descriptor instead.
func (*ReportTaskCompleteResponse) ProtoMessage
func (*ReportTaskCompleteResponse) ProtoMessage()func (*ReportTaskCompleteResponse) ProtoReflect
func (x *ReportTaskCompleteResponse) ProtoReflect() protoreflect.Messagefunc (*ReportTaskCompleteResponse) Reset
func (x *ReportTaskCompleteResponse) Reset()func (*ReportTaskCompleteResponse) String
func (x *ReportTaskCompleteResponse) String() stringReportTaskProgressRequest
type ReportTaskProgressRequest struct {
// Required. This is the Compute Engine instance identity token described in
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`
// Required. Unique identifier of the task this applies to.
TaskId string `protobuf:"bytes,2,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
// Required. The type of task to report progress on.
//
// Progress must include the appropriate message based on this enum as
// specified below:
// APPLY_PATCHES = ApplyPatchesTaskProgress
// EXEC_STEP = Progress not supported for this type.
// APPLY_CONFIG_TASK = ApplyConfigTaskProgress
TaskType TaskType `protobuf:"varint,3,opt,name=task_type,json=taskType,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.TaskType" json:"task_type,omitempty"`
// Intermediate progress of the current task.
//
// Types that are assignable to Progress:
//
// *ReportTaskProgressRequest_ApplyPatchesTaskProgress
// *ReportTaskProgressRequest_ExecStepTaskProgress
Progress isReportTaskProgressRequest_Progress `protobuf_oneof:"progress"`
// contains filtered or unexported fields
}A request message for reporting the progress of current task.
func (*ReportTaskProgressRequest) Descriptor
func (*ReportTaskProgressRequest) Descriptor() ([]byte, []int)Deprecated: Use ReportTaskProgressRequest.ProtoReflect.Descriptor instead.
func (*ReportTaskProgressRequest) GetApplyPatchesTaskProgress
func (x *ReportTaskProgressRequest) GetApplyPatchesTaskProgress() *ApplyPatchesTaskProgressfunc (*ReportTaskProgressRequest) GetExecStepTaskProgress
func (x *ReportTaskProgressRequest) GetExecStepTaskProgress() *ExecStepTaskProgressfunc (*ReportTaskProgressRequest) GetInstanceIdToken
func (x *ReportTaskProgressRequest) GetInstanceIdToken() stringfunc (*ReportTaskProgressRequest) GetProgress
func (m *ReportTaskProgressRequest) GetProgress() isReportTaskProgressRequest_Progressfunc (*ReportTaskProgressRequest) GetTaskId
func (x *ReportTaskProgressRequest) GetTaskId() stringfunc (*ReportTaskProgressRequest) GetTaskType
func (x *ReportTaskProgressRequest) GetTaskType() TaskTypefunc (*ReportTaskProgressRequest) ProtoMessage
func (*ReportTaskProgressRequest) ProtoMessage()func (*ReportTaskProgressRequest) ProtoReflect
func (x *ReportTaskProgressRequest) ProtoReflect() protoreflect.Messagefunc (*ReportTaskProgressRequest) Reset
func (x *ReportTaskProgressRequest) Reset()func (*ReportTaskProgressRequest) String
func (x *ReportTaskProgressRequest) String() stringReportTaskProgressRequest_ApplyPatchesTaskProgress
type ReportTaskProgressRequest_ApplyPatchesTaskProgress struct {
// Details about the progress of the apply patches task.
ApplyPatchesTaskProgress *ApplyPatchesTaskProgress `protobuf:"bytes,4,opt,name=apply_patches_task_progress,json=applyPatchesTaskProgress,proto3,oneof"`
}ReportTaskProgressRequest_ExecStepTaskProgress
type ReportTaskProgressRequest_ExecStepTaskProgress struct {
// Details about the progress of the exec step task.
ExecStepTaskProgress *ExecStepTaskProgress `protobuf:"bytes,5,opt,name=exec_step_task_progress,json=execStepTaskProgress,proto3,oneof"`
}ReportTaskProgressResponse
type ReportTaskProgressResponse struct {
// Instructs agent to continue or not.
TaskDirective TaskDirective `protobuf:"varint,1,opt,name=task_directive,json=taskDirective,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.TaskDirective" json:"task_directive,omitempty"`
// contains filtered or unexported fields
}The response message after the agent reported the current task progress.
func (*ReportTaskProgressResponse) Descriptor
func (*ReportTaskProgressResponse) Descriptor() ([]byte, []int)Deprecated: Use ReportTaskProgressResponse.ProtoReflect.Descriptor instead.
func (*ReportTaskProgressResponse) GetTaskDirective
func (x *ReportTaskProgressResponse) GetTaskDirective() TaskDirectivefunc (*ReportTaskProgressResponse) ProtoMessage
func (*ReportTaskProgressResponse) ProtoMessage()func (*ReportTaskProgressResponse) ProtoReflect
func (x *ReportTaskProgressResponse) ProtoReflect() protoreflect.Messagefunc (*ReportTaskProgressResponse) Reset
func (x *ReportTaskProgressResponse) Reset()func (*ReportTaskProgressResponse) String
func (x *ReportTaskProgressResponse) String() stringRetryStrategy
type RetryStrategy struct {
// If true, the agent will continue to try and patch until the window has
// ended.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// contains filtered or unexported fields
}The strategy for retrying failed patches during the patch window.
func (*RetryStrategy) Descriptor
func (*RetryStrategy) Descriptor() ([]byte, []int)Deprecated: Use RetryStrategy.ProtoReflect.Descriptor instead.
func (*RetryStrategy) GetEnabled
func (x *RetryStrategy) GetEnabled() boolfunc (*RetryStrategy) ProtoMessage
func (*RetryStrategy) ProtoMessage()func (*RetryStrategy) ProtoReflect
func (x *RetryStrategy) ProtoReflect() protoreflect.Messagefunc (*RetryStrategy) Reset
func (x *RetryStrategy) Reset()func (*RetryStrategy) String
func (x *RetryStrategy) String() stringSoftwareRecipe
type SoftwareRecipe struct {
// 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. Install steps
// must be specified and are used on first installation.
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.
// Upgrade steps are not mandatory and are only used when upgrading.
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.agentendpoint.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 INSTALLED_KEEP_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 {
// 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 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 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 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 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 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 {
// 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 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 {
// 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"`
// The type of the archive to extract.
Type SoftwareRecipe_Step_ExtractArchive_ArchiveType `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.osconfig.agentendpoint.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 {
// 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 {
// 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 {
// 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 {
// 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.agentendpoint.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"`
}StartNextTaskRequest
type StartNextTaskRequest struct {
// Required. This is the Compute Engine instance identity token described in
// https://cloud.google.com/compute/docs/instances/verifying-instance-identity
// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`
// contains filtered or unexported fields
}A request message for signaling the start of a task execution.
func (*StartNextTaskRequest) Descriptor
func (*StartNextTaskRequest) Descriptor() ([]byte, []int)Deprecated: Use StartNextTaskRequest.ProtoReflect.Descriptor instead.
func (*StartNextTaskRequest) GetInstanceIdToken
func (x *StartNextTaskRequest) GetInstanceIdToken() stringfunc (*StartNextTaskRequest) ProtoMessage
func (*StartNextTaskRequest) ProtoMessage()func (*StartNextTaskRequest) ProtoReflect
func (x *StartNextTaskRequest) ProtoReflect() protoreflect.Messagefunc (*StartNextTaskRequest) Reset
func (x *StartNextTaskRequest) Reset()func (*StartNextTaskRequest) String
func (x *StartNextTaskRequest) String() stringStartNextTaskResponse
type StartNextTaskResponse struct {
// The details of the task that should be worked on. Can be empty if there
// is no new task to work on.
Task *Task `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
// contains filtered or unexported fields
}A response message that contains the details of the task to work on.
func (*StartNextTaskResponse) Descriptor
func (*StartNextTaskResponse) Descriptor() ([]byte, []int)Deprecated: Use StartNextTaskResponse.ProtoReflect.Descriptor instead.
func (*StartNextTaskResponse) GetTask
func (x *StartNextTaskResponse) GetTask() *Taskfunc (*StartNextTaskResponse) ProtoMessage
func (*StartNextTaskResponse) ProtoMessage()func (*StartNextTaskResponse) ProtoReflect
func (x *StartNextTaskResponse) ProtoReflect() protoreflect.Messagefunc (*StartNextTaskResponse) Reset
func (x *StartNextTaskResponse) Reset()func (*StartNextTaskResponse) String
func (x *StartNextTaskResponse) String() stringTask
type Task struct {
// Unique task id.
TaskId string `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
// The type of task to perform.
//
// Task details must include the appropriate message based on this enum as
// specified below:
// APPLY_PATCHES = ApplyPatchesTask
// EXEC_STEP = ExecStepTask;
TaskType TaskType `protobuf:"varint,2,opt,name=task_type,json=taskType,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.TaskType" json:"task_type,omitempty"`
// Current directive to the agent.
TaskDirective TaskDirective `protobuf:"varint,3,opt,name=task_directive,json=taskDirective,proto3,enum=google.cloud.osconfig.agentendpoint.v1beta.TaskDirective" json:"task_directive,omitempty"`
// Specific details about the current task to perform.
//
// Types that are assignable to TaskDetails:
//
// *Task_ApplyPatchesTask
// *Task_ExecStepTask
TaskDetails isTask_TaskDetails `protobuf_oneof:"task_details"`
// Labels describing the task. Used for logging by the agent.
ServiceLabels map[string]string `protobuf:"bytes,6,rep,name=service_labels,json=serviceLabels,proto3" json:"service_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}A unit of work to be performed by the agent.
func (*Task) Descriptor
Deprecated: Use Task.ProtoReflect.Descriptor instead.
func (*Task) GetApplyPatchesTask
func (x *Task) GetApplyPatchesTask() *ApplyPatchesTaskfunc (*Task) GetExecStepTask
func (x *Task) GetExecStepTask() *ExecStepTaskfunc (*Task) GetServiceLabels
func (*Task) GetTaskDetails
func (m *Task) GetTaskDetails() isTask_TaskDetailsfunc (*Task) GetTaskDirective
func (x *Task) GetTaskDirective() TaskDirectivefunc (*Task) GetTaskId
func (*Task) GetTaskType
func (*Task) ProtoMessage
func (*Task) ProtoMessage()func (*Task) ProtoReflect
func (x *Task) ProtoReflect() protoreflect.Messagefunc (*Task) Reset
func (x *Task) Reset()func (*Task) String
TaskDirective
type TaskDirective int32Specifies the current agent behavior.
TaskDirective_TASK_DIRECTIVE_UNSPECIFIED, TaskDirective_CONTINUE, TaskDirective_STOP
const (
// Unspecified is invalid.
TaskDirective_TASK_DIRECTIVE_UNSPECIFIED TaskDirective = 0
// The task should continue to progress.
TaskDirective_CONTINUE TaskDirective = 1
// Task should not be started, or if already in progress, should stop
// at first safe stopping point. Task should be considered done and will
// never repeat.
TaskDirective_STOP TaskDirective = 2
)func (TaskDirective) Descriptor
func (TaskDirective) Descriptor() protoreflect.EnumDescriptorfunc (TaskDirective) Enum
func (x TaskDirective) Enum() *TaskDirectivefunc (TaskDirective) EnumDescriptor
func (TaskDirective) EnumDescriptor() ([]byte, []int)Deprecated: Use TaskDirective.Descriptor instead.
func (TaskDirective) Number
func (x TaskDirective) Number() protoreflect.EnumNumberfunc (TaskDirective) String
func (x TaskDirective) String() stringfunc (TaskDirective) Type
func (TaskDirective) Type() protoreflect.EnumTypeTaskType
type TaskType int32Specifies the type of task to perform.
TaskType_TASK_TYPE_UNSPECIFIED, TaskType_APPLY_PATCHES, TaskType_EXEC_STEP_TASK
const (
// Unspecified is invalid.
TaskType_TASK_TYPE_UNSPECIFIED TaskType = 0
// The apply patches task.
TaskType_APPLY_PATCHES TaskType = 1
// The exec step task.
TaskType_EXEC_STEP_TASK TaskType = 2
)func (TaskType) Descriptor
func (TaskType) Descriptor() protoreflect.EnumDescriptorfunc (TaskType) Enum
func (TaskType) EnumDescriptor
Deprecated: Use TaskType.Descriptor instead.
func (TaskType) Number
func (x TaskType) Number() protoreflect.EnumNumberfunc (TaskType) String
func (TaskType) Type
func (TaskType) Type() protoreflect.EnumTypeTask_ApplyPatchesTask
type Task_ApplyPatchesTask struct {
// Details about the apply patches task to perform.
ApplyPatchesTask *ApplyPatchesTask `protobuf:"bytes,4,opt,name=apply_patches_task,json=applyPatchesTask,proto3,oneof"`
}Task_ExecStepTask
type Task_ExecStepTask struct {
// Details about the exec step task to perform.
ExecStepTask *ExecStepTask `protobuf:"bytes,5,opt,name=exec_step_task,json=execStepTask,proto3,oneof"`
}UnimplementedAgentEndpointServiceServer
type UnimplementedAgentEndpointServiceServer struct {
}UnimplementedAgentEndpointServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedAgentEndpointServiceServer) LookupEffectiveGuestPolicy
func (UnimplementedAgentEndpointServiceServer) LookupEffectiveGuestPolicy(context.Context, *LookupEffectiveGuestPolicyRequest) (*EffectiveGuestPolicy, error)func (UnimplementedAgentEndpointServiceServer) ReceiveTaskNotification
func (UnimplementedAgentEndpointServiceServer) ReceiveTaskNotification(*ReceiveTaskNotificationRequest, AgentEndpointService_ReceiveTaskNotificationServer) errorfunc (UnimplementedAgentEndpointServiceServer) RegisterAgent
func (UnimplementedAgentEndpointServiceServer) RegisterAgent(context.Context, *RegisterAgentRequest) (*RegisterAgentResponse, error)func (UnimplementedAgentEndpointServiceServer) ReportTaskComplete
func (UnimplementedAgentEndpointServiceServer) ReportTaskComplete(context.Context, *ReportTaskCompleteRequest) (*ReportTaskCompleteResponse, error)func (UnimplementedAgentEndpointServiceServer) ReportTaskProgress
func (UnimplementedAgentEndpointServiceServer) ReportTaskProgress(context.Context, *ReportTaskProgressRequest) (*ReportTaskProgressResponse, error)func (UnimplementedAgentEndpointServiceServer) StartNextTask
func (UnimplementedAgentEndpointServiceServer) StartNextTask(context.Context, *StartNextTaskRequest) (*StartNextTaskResponse, error)UnsafeAgentEndpointServiceServer
type UnsafeAgentEndpointServiceServer interface {
// contains filtered or unexported methods
}UnsafeAgentEndpointServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AgentEndpointServiceServer will result in compilation errors.
WindowsUpdateSettings
type WindowsUpdateSettings struct {
// Only apply updates of these windows update classifications. If empty, all
// updates will be applied.
Classifications []WindowsUpdateSettings_Classification `protobuf:"varint,1,rep,packed,name=classifications,proto3,enum=google.cloud.osconfig.agentendpoint.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 {
// 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"`
// 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 will be 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 will be 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 {
// 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"`
// 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