Package cloud.google.com/go/osconfig/agentendpoint/apiv1beta/agentendpointpb (v1.12.5)

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.

File_google_cloud_osconfig_agentendpoint_v1beta_agentendpoint_proto

var File_google_cloud_osconfig_agentendpoint_v1beta_agentendpoint_proto protoreflect.FileDescriptor

File_google_cloud_osconfig_agentendpoint_v1beta_guest_policies_proto

var File_google_cloud_osconfig_agentendpoint_v1beta_guest_policies_proto protoreflect.FileDescriptor

File_google_cloud_osconfig_agentendpoint_v1beta_patch_jobs_proto

var File_google_cloud_osconfig_agentendpoint_v1beta_patch_jobs_proto protoreflect.FileDescriptor

File_google_cloud_osconfig_agentendpoint_v1beta_tasks_proto

var File_google_cloud_osconfig_agentendpoint_v1beta_tasks_proto protoreflect.FileDescriptor

Functions

func RegisterAgentEndpointServiceServer

func RegisterAgentEndpointServiceServer(s *grpc.Server, 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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAgentEndpointServiceClient

func NewAgentEndpointServiceClient(cc grpc.ClientConnInterface) AgentEndpointServiceClient

AgentEndpointServiceServer

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.

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() bool

func (*ApplyPatchesTask) GetPatchConfig

func (x *ApplyPatchesTask) GetPatchConfig() *PatchConfig

func (*ApplyPatchesTask) ProtoMessage

func (*ApplyPatchesTask) ProtoMessage()

func (*ApplyPatchesTask) ProtoReflect

func (x *ApplyPatchesTask) ProtoReflect() protoreflect.Message

func (*ApplyPatchesTask) Reset

func (x *ApplyPatchesTask) Reset()

func (*ApplyPatchesTask) String

func (x *ApplyPatchesTask) String() string

ApplyPatchesTaskOutput

type ApplyPatchesTaskOutput struct {
	State ApplyPatchesTaskOutput_State "" /* 141 byte string literal not displayed */

}

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 (*ApplyPatchesTaskOutput) ProtoMessage

func (*ApplyPatchesTaskOutput) ProtoMessage()

func (*ApplyPatchesTaskOutput) ProtoReflect

func (x *ApplyPatchesTaskOutput) ProtoReflect() protoreflect.Message

func (*ApplyPatchesTaskOutput) Reset

func (x *ApplyPatchesTaskOutput) Reset()

func (*ApplyPatchesTaskOutput) String

func (x *ApplyPatchesTaskOutput) String() string

ApplyPatchesTaskOutput_State

type ApplyPatchesTaskOutput_State int32

The 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) Enum

func (ApplyPatchesTaskOutput_State) EnumDescriptor

func (ApplyPatchesTaskOutput_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ApplyPatchesTaskOutput_State.Descriptor instead.

func (ApplyPatchesTaskOutput_State) Number

func (ApplyPatchesTaskOutput_State) String

func (ApplyPatchesTaskOutput_State) Type

ApplyPatchesTaskProgress

type ApplyPatchesTaskProgress struct {
	State ApplyPatchesTaskProgress_State "" /* 143 byte string literal not displayed */

}

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 (*ApplyPatchesTaskProgress) ProtoMessage

func (*ApplyPatchesTaskProgress) ProtoMessage()

func (*ApplyPatchesTaskProgress) ProtoReflect

func (x *ApplyPatchesTaskProgress) ProtoReflect() protoreflect.Message

func (*ApplyPatchesTaskProgress) Reset

func (x *ApplyPatchesTaskProgress) Reset()

func (*ApplyPatchesTaskProgress) String

func (x *ApplyPatchesTaskProgress) String() string

ApplyPatchesTaskProgress_State

type ApplyPatchesTaskProgress_State int32

The 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) Enum

func (ApplyPatchesTaskProgress_State) EnumDescriptor

func (ApplyPatchesTaskProgress_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ApplyPatchesTaskProgress_State.Descriptor instead.

func (ApplyPatchesTaskProgress_State) Number

func (ApplyPatchesTaskProgress_State) String

func (ApplyPatchesTaskProgress_State) Type

AptRepository

type AptRepository struct {
	ArchiveType AptRepository_ArchiveType "" /* 169 byte string literal not displayed */

	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`

	Distribution string `protobuf:"bytes,3,opt,name=distribution,proto3" json:"distribution,omitempty"`

	Components []string `protobuf:"bytes,4,rep,name=components,proto3" json:"components,omitempty"`

	GpgKey string `protobuf:"bytes,5,opt,name=gpg_key,json=gpgKey,proto3" json:"gpg_key,omitempty"`

}

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_ArchiveType

func (*AptRepository) GetComponents

func (x *AptRepository) GetComponents() []string

func (*AptRepository) GetDistribution

func (x *AptRepository) GetDistribution() string

func (*AptRepository) GetGpgKey

func (x *AptRepository) GetGpgKey() string

func (*AptRepository) GetUri

func (x *AptRepository) GetUri() string

func (*AptRepository) ProtoMessage

func (*AptRepository) ProtoMessage()

func (*AptRepository) ProtoReflect

func (x *AptRepository) ProtoReflect() protoreflect.Message

func (*AptRepository) Reset

func (x *AptRepository) Reset()

func (*AptRepository) String

func (x *AptRepository) String() string

AptRepository_ArchiveType

type AptRepository_ArchiveType int32

Type 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) Enum

func (AptRepository_ArchiveType) EnumDescriptor

func (AptRepository_ArchiveType) EnumDescriptor() ([]byte, []int)

Deprecated: Use AptRepository_ArchiveType.Descriptor instead.

func (AptRepository_ArchiveType) Number

func (AptRepository_ArchiveType) String

func (x AptRepository_ArchiveType) String() string

func (AptRepository_ArchiveType) Type

AptSettings

type AptSettings struct {
	Type AptSettings_Type "" /* 127 byte string literal not displayed */

	Excludes []string `protobuf:"bytes,2,rep,name=excludes,proto3" json:"excludes,omitempty"`

	ExclusivePackages []string `protobuf:"bytes,3,rep,name=exclusive_packages,json=exclusivePackages,proto3" json:"exclusive_packages,omitempty"`

}

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() []string

func (*AptSettings) GetExclusivePackages

func (x *AptSettings) GetExclusivePackages() []string

func (*AptSettings) GetType

func (x *AptSettings) GetType() AptSettings_Type

func (*AptSettings) ProtoMessage

func (*AptSettings) ProtoMessage()

func (*AptSettings) ProtoReflect

func (x *AptSettings) ProtoReflect() protoreflect.Message

func (*AptSettings) Reset

func (x *AptSettings) Reset()

func (*AptSettings) String

func (x *AptSettings) String() string

AptSettings_Type

type AptSettings_Type int32

Apt 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) Enum

func (AptSettings_Type) EnumDescriptor

func (AptSettings_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use AptSettings_Type.Descriptor instead.

func (AptSettings_Type) Number

func (AptSettings_Type) String

func (x AptSettings_Type) String() string

func (AptSettings_Type) Type

DesiredState

type DesiredState int32

The 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) Enum

func (x DesiredState) Enum() *DesiredState

func (DesiredState) EnumDescriptor

func (DesiredState) EnumDescriptor() ([]byte, []int)

Deprecated: Use DesiredState.Descriptor instead.

func (DesiredState) Number

func (DesiredState) String

func (x DesiredState) String() string

func (DesiredState) Type

EffectiveGuestPolicy

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 (*EffectiveGuestPolicy) GetPackages

func (*EffectiveGuestPolicy) GetSoftwareRecipes

func (*EffectiveGuestPolicy) ProtoMessage

func (*EffectiveGuestPolicy) ProtoMessage()

func (*EffectiveGuestPolicy) ProtoReflect

func (x *EffectiveGuestPolicy) ProtoReflect() protoreflect.Message

func (*EffectiveGuestPolicy) Reset

func (x *EffectiveGuestPolicy) Reset()

func (*EffectiveGuestPolicy) String

func (x *EffectiveGuestPolicy) String() string

EffectiveGuestPolicy_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 (*EffectiveGuestPolicy_SourcedPackage) GetSource

func (*EffectiveGuestPolicy_SourcedPackage) ProtoMessage

func (*EffectiveGuestPolicy_SourcedPackage) ProtoMessage()

func (*EffectiveGuestPolicy_SourcedPackage) ProtoReflect

func (*EffectiveGuestPolicy_SourcedPackage) Reset

func (*EffectiveGuestPolicy_SourcedPackage) String

EffectiveGuestPolicy_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

Deprecated: Use EffectiveGuestPolicy_SourcedPackageRepository.ProtoReflect.Descriptor instead.

func (*EffectiveGuestPolicy_SourcedPackageRepository) GetPackageRepository

func (*EffectiveGuestPolicy_SourcedPackageRepository) GetSource

func (*EffectiveGuestPolicy_SourcedPackageRepository) ProtoMessage

func (*EffectiveGuestPolicy_SourcedPackageRepository) ProtoReflect

func (*EffectiveGuestPolicy_SourcedPackageRepository) Reset

func (*EffectiveGuestPolicy_SourcedPackageRepository) String

EffectiveGuestPolicy_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

Deprecated: Use EffectiveGuestPolicy_SourcedSoftwareRecipe.ProtoReflect.Descriptor instead.

func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) GetSoftwareRecipe

func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) GetSource

func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) ProtoMessage

func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) ProtoReflect

func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) Reset

func (*EffectiveGuestPolicy_SourcedSoftwareRecipe) String

ExecStep

type ExecStep struct {
	LinuxExecStepConfig *ExecStepConfig `protobuf:"bytes,1,opt,name=linux_exec_step_config,json=linuxExecStepConfig,proto3" json:"linux_exec_step_config,omitempty"`

	WindowsExecStepConfig *ExecStepConfig "" /* 128 byte string literal not displayed */

}

A step that runs an executable for a PatchJob.

func (*ExecStep) Descriptor

func (*ExecStep) Descriptor() ([]byte, []int)

Deprecated: Use ExecStep.ProtoReflect.Descriptor instead.

func (*ExecStep) GetLinuxExecStepConfig

func (x *ExecStep) GetLinuxExecStepConfig() *ExecStepConfig

func (*ExecStep) GetWindowsExecStepConfig

func (x *ExecStep) GetWindowsExecStepConfig() *ExecStepConfig

func (*ExecStep) ProtoMessage

func (*ExecStep) ProtoMessage()

func (*ExecStep) ProtoReflect

func (x *ExecStep) ProtoReflect() protoreflect.Message

func (*ExecStep) Reset

func (x *ExecStep) Reset()

func (*ExecStep) String

func (x *ExecStep) String() string

ExecStepConfig

type ExecStepConfig struct {
	Executable isExecStepConfig_Executable `protobuf_oneof:"executable"`

	AllowedSuccessCodes []int32 "" /* 128 byte string literal not displayed */

	Interpreter ExecStepConfig_Interpreter "" /* 151 byte string literal not displayed */

}

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() []int32

func (*ExecStepConfig) GetExecutable

func (m *ExecStepConfig) GetExecutable() isExecStepConfig_Executable

func (*ExecStepConfig) GetGcsObject

func (x *ExecStepConfig) GetGcsObject() *GcsObject

func (*ExecStepConfig) GetInterpreter

func (x *ExecStepConfig) GetInterpreter() ExecStepConfig_Interpreter

func (*ExecStepConfig) GetLocalPath

func (x *ExecStepConfig) GetLocalPath() string

func (*ExecStepConfig) ProtoMessage

func (*ExecStepConfig) ProtoMessage()

func (*ExecStepConfig) ProtoReflect

func (x *ExecStepConfig) ProtoReflect() protoreflect.Message

func (*ExecStepConfig) Reset

func (x *ExecStepConfig) Reset()

func (*ExecStepConfig) String

func (x *ExecStepConfig) String() string

ExecStepConfig_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 int32

The 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) Enum

func (ExecStepConfig_Interpreter) EnumDescriptor

func (ExecStepConfig_Interpreter) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExecStepConfig_Interpreter.Descriptor instead.

func (ExecStepConfig_Interpreter) Number

func (ExecStepConfig_Interpreter) String

func (ExecStepConfig_Interpreter) Type

ExecStepConfig_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() *ExecStep

func (*ExecStepTask) ProtoMessage

func (*ExecStepTask) ProtoMessage()

func (*ExecStepTask) ProtoReflect

func (x *ExecStepTask) ProtoReflect() protoreflect.Message

func (*ExecStepTask) Reset

func (x *ExecStepTask) Reset()

func (*ExecStepTask) String

func (x *ExecStepTask) String() string

ExecStepTaskOutput

type ExecStepTaskOutput struct {
	State ExecStepTaskOutput_State "" /* 137 byte string literal not displayed */

	ExitCode int32 `protobuf:"varint,2,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`

}

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() int32

func (*ExecStepTaskOutput) GetState

func (*ExecStepTaskOutput) ProtoMessage

func (*ExecStepTaskOutput) ProtoMessage()

func (*ExecStepTaskOutput) ProtoReflect

func (x *ExecStepTaskOutput) ProtoReflect() protoreflect.Message

func (*ExecStepTaskOutput) Reset

func (x *ExecStepTaskOutput) Reset()

func (*ExecStepTaskOutput) String

func (x *ExecStepTaskOutput) String() string

ExecStepTaskOutput_State

type ExecStepTaskOutput_State int32

The 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) Enum

func (ExecStepTaskOutput_State) EnumDescriptor

func (ExecStepTaskOutput_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExecStepTaskOutput_State.Descriptor instead.

func (ExecStepTaskOutput_State) Number

func (ExecStepTaskOutput_State) String

func (x ExecStepTaskOutput_State) String() string

func (ExecStepTaskOutput_State) Type

ExecStepTaskProgress

type ExecStepTaskProgress struct {
	State ExecStepTaskProgress_State "" /* 139 byte string literal not displayed */

}

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 (*ExecStepTaskProgress) ProtoMessage

func (*ExecStepTaskProgress) ProtoMessage()

func (*ExecStepTaskProgress) ProtoReflect

func (x *ExecStepTaskProgress) ProtoReflect() protoreflect.Message

func (*ExecStepTaskProgress) Reset

func (x *ExecStepTaskProgress) Reset()

func (*ExecStepTaskProgress) String

func (x *ExecStepTaskProgress) String() string

ExecStepTaskProgress_State

type ExecStepTaskProgress_State int32

The 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) Enum

func (ExecStepTaskProgress_State) EnumDescriptor

func (ExecStepTaskProgress_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExecStepTaskProgress_State.Descriptor instead.

func (ExecStepTaskProgress_State) Number

func (ExecStepTaskProgress_State) String

func (ExecStepTaskProgress_State) Type

GcsObject

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

func (*GcsObject) Descriptor() ([]byte, []int)

Deprecated: Use GcsObject.ProtoReflect.Descriptor instead.

func (*GcsObject) GetBucket

func (x *GcsObject) GetBucket() string

func (*GcsObject) GetGenerationNumber

func (x *GcsObject) GetGenerationNumber() int64

func (*GcsObject) GetObject

func (x *GcsObject) GetObject() string

func (*GcsObject) ProtoMessage

func (*GcsObject) ProtoMessage()

func (*GcsObject) ProtoReflect

func (x *GcsObject) ProtoReflect() protoreflect.Message

func (*GcsObject) Reset

func (x *GcsObject) Reset()

func (*GcsObject) String

func (x *GcsObject) String() 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() string

func (*GooRepository) GetUrl

func (x *GooRepository) GetUrl() string

func (*GooRepository) ProtoMessage

func (*GooRepository) ProtoMessage()

func (*GooRepository) ProtoReflect

func (x *GooRepository) ProtoReflect() protoreflect.Message

func (*GooRepository) Reset

func (x *GooRepository) Reset()

func (*GooRepository) String

func (x *GooRepository) String() string

GooSettings

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

func (*GooSettings) Reset

func (x *GooSettings) Reset()

func (*GooSettings) String

func (x *GooSettings) String() string

LookupEffectiveGuestPolicyRequest

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() string

func (*LookupEffectiveGuestPolicyRequest) GetOsArchitecture

func (x *LookupEffectiveGuestPolicyRequest) GetOsArchitecture() string

func (*LookupEffectiveGuestPolicyRequest) GetOsShortName

func (x *LookupEffectiveGuestPolicyRequest) GetOsShortName() string

func (*LookupEffectiveGuestPolicyRequest) GetOsVersion

func (x *LookupEffectiveGuestPolicyRequest) GetOsVersion() string

func (*LookupEffectiveGuestPolicyRequest) ProtoMessage

func (*LookupEffectiveGuestPolicyRequest) ProtoMessage()

func (*LookupEffectiveGuestPolicyRequest) ProtoReflect

func (*LookupEffectiveGuestPolicyRequest) Reset

func (*LookupEffectiveGuestPolicyRequest) String

Package

type Package struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DesiredState DesiredState "" /* 159 byte string literal not displayed */

	Manager Package_Manager "" /* 132 byte string literal not displayed */

}

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

func (*Package) Descriptor() ([]byte, []int)

Deprecated: Use Package.ProtoReflect.Descriptor instead.

func (*Package) GetDesiredState

func (x *Package) GetDesiredState() DesiredState

func (*Package) GetManager

func (x *Package) GetManager() Package_Manager

func (*Package) GetName

func (x *Package) GetName() string

func (*Package) ProtoMessage

func (*Package) ProtoMessage()

func (*Package) ProtoReflect

func (x *Package) ProtoReflect() protoreflect.Message

func (*Package) Reset

func (x *Package) Reset()

func (*Package) String

func (x *Package) String() 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() *AptRepository

func (*PackageRepository) GetGoo

func (x *PackageRepository) GetGoo() *GooRepository

func (*PackageRepository) GetRepository

func (m *PackageRepository) GetRepository() isPackageRepository_Repository

func (*PackageRepository) GetYum

func (x *PackageRepository) GetYum() *YumRepository

func (*PackageRepository) GetZypper

func (x *PackageRepository) GetZypper() *ZypperRepository

func (*PackageRepository) ProtoMessage

func (*PackageRepository) ProtoMessage()

func (*PackageRepository) ProtoReflect

func (x *PackageRepository) ProtoReflect() protoreflect.Message

func (*PackageRepository) Reset

func (x *PackageRepository) Reset()

func (*PackageRepository) String

func (x *PackageRepository) String() string

PackageRepository_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 int32

Types 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) Enum

func (x Package_Manager) Enum() *Package_Manager

func (Package_Manager) EnumDescriptor

func (Package_Manager) EnumDescriptor() ([]byte, []int)

Deprecated: Use Package_Manager.Descriptor instead.

func (Package_Manager) Number

func (Package_Manager) String

func (x Package_Manager) String() string

func (Package_Manager) Type

PatchConfig

type PatchConfig struct {
	RebootConfig PatchConfig_RebootConfig "" /* 171 byte string literal not displayed */

	RetryStrategy *RetryStrategy `protobuf:"bytes,2,opt,name=retry_strategy,json=retryStrategy,proto3" json:"retry_strategy,omitempty"`

	Apt *AptSettings `protobuf:"bytes,3,opt,name=apt,proto3" json:"apt,omitempty"`

	Yum *YumSettings `protobuf:"bytes,4,opt,name=yum,proto3" json:"yum,omitempty"`

	Goo *GooSettings `protobuf:"bytes,5,opt,name=goo,proto3" json:"goo,omitempty"`

	Zypper *ZypperSettings `protobuf:"bytes,6,opt,name=zypper,proto3" json:"zypper,omitempty"`

	WindowsUpdate *WindowsUpdateSettings `protobuf:"bytes,7,opt,name=windows_update,json=windowsUpdate,proto3" json:"windows_update,omitempty"`

	PreStep *ExecStep `protobuf:"bytes,8,opt,name=pre_step,json=preStep,proto3" json:"pre_step,omitempty"`

	PostStep *ExecStep `protobuf:"bytes,9,opt,name=post_step,json=postStep,proto3" json:"post_step,omitempty"`

	MigInstancesAllowed bool `protobuf:"varint,10,opt,name=mig_instances_allowed,json=migInstancesAllowed,proto3" json:"mig_instances_allowed,omitempty"`

}

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() *AptSettings

func (*PatchConfig) GetGoo

func (x *PatchConfig) GetGoo() *GooSettings

func (*PatchConfig) GetMigInstancesAllowed

func (x *PatchConfig) GetMigInstancesAllowed() bool

func (*PatchConfig) GetPostStep

func (x *PatchConfig) GetPostStep() *ExecStep

func (*PatchConfig) GetPreStep

func (x *PatchConfig) GetPreStep() *ExecStep

func (*PatchConfig) GetRebootConfig

func (x *PatchConfig) GetRebootConfig() PatchConfig_RebootConfig

func (*PatchConfig) GetRetryStrategy

func (x *PatchConfig) GetRetryStrategy() *RetryStrategy

func (*PatchConfig) GetWindowsUpdate

func (x *PatchConfig) GetWindowsUpdate() *WindowsUpdateSettings

func (*PatchConfig) GetYum

func (x *PatchConfig) GetYum() *YumSettings

func (*PatchConfig) GetZypper

func (x *PatchConfig) GetZypper() *ZypperSettings

func (*PatchConfig) ProtoMessage

func (*PatchConfig) ProtoMessage()

func (*PatchConfig) ProtoReflect

func (x *PatchConfig) ProtoReflect() protoreflect.Message

func (*PatchConfig) Reset

func (x *PatchConfig) Reset()

func (*PatchConfig) String

func (x *PatchConfig) String() string

PatchConfig_RebootConfig

type PatchConfig_RebootConfig int32

Post-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) Enum

func (PatchConfig_RebootConfig) EnumDescriptor

func (PatchConfig_RebootConfig) EnumDescriptor() ([]byte, []int)

Deprecated: Use PatchConfig_RebootConfig.Descriptor instead.

func (PatchConfig_RebootConfig) Number

func (PatchConfig_RebootConfig) String

func (x PatchConfig_RebootConfig) String() string

func (PatchConfig_RebootConfig) Type

ReceiveTaskNotificationRequest

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() string

func (*ReceiveTaskNotificationRequest) GetInstanceIdToken

func (x *ReceiveTaskNotificationRequest) GetInstanceIdToken() string

func (*ReceiveTaskNotificationRequest) ProtoMessage

func (*ReceiveTaskNotificationRequest) ProtoMessage()

func (*ReceiveTaskNotificationRequest) ProtoReflect

func (*ReceiveTaskNotificationRequest) Reset

func (x *ReceiveTaskNotificationRequest) Reset()

func (*ReceiveTaskNotificationRequest) String

ReceiveTaskNotificationResponse

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 (*ReceiveTaskNotificationResponse) Reset

func (*ReceiveTaskNotificationResponse) String

RegisterAgentRequest

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() string

func (*RegisterAgentRequest) GetInstanceIdToken

func (x *RegisterAgentRequest) GetInstanceIdToken() string

func (*RegisterAgentRequest) GetOsArchitecture

func (x *RegisterAgentRequest) GetOsArchitecture() string

func (*RegisterAgentRequest) GetOsLongName

func (x *RegisterAgentRequest) GetOsLongName() string

func (*RegisterAgentRequest) GetOsShortName

func (x *RegisterAgentRequest) GetOsShortName() string

func (*RegisterAgentRequest) GetOsVersion

func (x *RegisterAgentRequest) GetOsVersion() string

func (*RegisterAgentRequest) GetSupportedCapabilities

func (x *RegisterAgentRequest) GetSupportedCapabilities() []string

func (*RegisterAgentRequest) ProtoMessage

func (*RegisterAgentRequest) ProtoMessage()

func (*RegisterAgentRequest) ProtoReflect

func (x *RegisterAgentRequest) ProtoReflect() protoreflect.Message

func (*RegisterAgentRequest) Reset

func (x *RegisterAgentRequest) Reset()

func (*RegisterAgentRequest) String

func (x *RegisterAgentRequest) String() string

RegisterAgentResponse

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

func (*RegisterAgentResponse) Reset

func (x *RegisterAgentResponse) Reset()

func (*RegisterAgentResponse) String

func (x *RegisterAgentResponse) String() string

ReportTaskCompleteRequest

type ReportTaskCompleteRequest struct {
	InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`

	TaskId string `protobuf:"bytes,2,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`

	TaskType TaskType "" /* 143 byte string literal not displayed */

	ErrorMessage string `protobuf:"bytes,4,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`

	Output isReportTaskCompleteRequest_Output `protobuf_oneof:"output"`

}

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() *ApplyPatchesTaskOutput

func (*ReportTaskCompleteRequest) GetErrorMessage

func (x *ReportTaskCompleteRequest) GetErrorMessage() string

func (*ReportTaskCompleteRequest) GetExecStepTaskOutput

func (x *ReportTaskCompleteRequest) GetExecStepTaskOutput() *ExecStepTaskOutput

func (*ReportTaskCompleteRequest) GetInstanceIdToken

func (x *ReportTaskCompleteRequest) GetInstanceIdToken() string

func (*ReportTaskCompleteRequest) GetOutput

func (m *ReportTaskCompleteRequest) GetOutput() isReportTaskCompleteRequest_Output

func (*ReportTaskCompleteRequest) GetTaskId

func (x *ReportTaskCompleteRequest) GetTaskId() string

func (*ReportTaskCompleteRequest) GetTaskType

func (x *ReportTaskCompleteRequest) GetTaskType() TaskType

func (*ReportTaskCompleteRequest) ProtoMessage

func (*ReportTaskCompleteRequest) ProtoMessage()

func (*ReportTaskCompleteRequest) ProtoReflect

func (*ReportTaskCompleteRequest) Reset

func (x *ReportTaskCompleteRequest) Reset()

func (*ReportTaskCompleteRequest) String

func (x *ReportTaskCompleteRequest) String() string

ReportTaskCompleteRequest_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 (*ReportTaskCompleteResponse) Reset

func (x *ReportTaskCompleteResponse) Reset()

func (*ReportTaskCompleteResponse) String

func (x *ReportTaskCompleteResponse) String() string

ReportTaskProgressRequest

type ReportTaskProgressRequest struct {
	InstanceIdToken string `protobuf:"bytes,1,opt,name=instance_id_token,json=instanceIdToken,proto3" json:"instance_id_token,omitempty"`

	TaskId string `protobuf:"bytes,2,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`

	TaskType TaskType "" /* 143 byte string literal not displayed */

	Progress isReportTaskProgressRequest_Progress `protobuf_oneof:"progress"`

}

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() *ApplyPatchesTaskProgress

func (*ReportTaskProgressRequest) GetExecStepTaskProgress

func (x *ReportTaskProgressRequest) GetExecStepTaskProgress() *ExecStepTaskProgress

func (*ReportTaskProgressRequest) GetInstanceIdToken

func (x *ReportTaskProgressRequest) GetInstanceIdToken() string

func (*ReportTaskProgressRequest) GetProgress

func (m *ReportTaskProgressRequest) GetProgress() isReportTaskProgressRequest_Progress

func (*ReportTaskProgressRequest) GetTaskId

func (x *ReportTaskProgressRequest) GetTaskId() string

func (*ReportTaskProgressRequest) GetTaskType

func (x *ReportTaskProgressRequest) GetTaskType() TaskType

func (*ReportTaskProgressRequest) ProtoMessage

func (*ReportTaskProgressRequest) ProtoMessage()

func (*ReportTaskProgressRequest) ProtoReflect

func (*ReportTaskProgressRequest) Reset

func (x *ReportTaskProgressRequest) Reset()

func (*ReportTaskProgressRequest) String

func (x *ReportTaskProgressRequest) String() string

ReportTaskProgressRequest_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 {
	TaskDirective TaskDirective "" /* 163 byte string literal not displayed */

}

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() TaskDirective

func (*ReportTaskProgressResponse) ProtoMessage

func (*ReportTaskProgressResponse) ProtoMessage()

func (*ReportTaskProgressResponse) ProtoReflect

func (*ReportTaskProgressResponse) Reset

func (x *ReportTaskProgressResponse) Reset()

func (*ReportTaskProgressResponse) String

func (x *ReportTaskProgressResponse) String() string

RetryStrategy

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() bool

func (*RetryStrategy) ProtoMessage

func (*RetryStrategy) ProtoMessage()

func (*RetryStrategy) ProtoReflect

func (x *RetryStrategy) ProtoReflect() protoreflect.Message

func (*RetryStrategy) Reset

func (x *RetryStrategy) Reset()

func (*RetryStrategy) String

func (x *RetryStrategy) String() string

SoftwareRecipe

type SoftwareRecipe struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`

	Artifacts []*SoftwareRecipe_Artifact `protobuf:"bytes,3,rep,name=artifacts,proto3" json:"artifacts,omitempty"`

	InstallSteps []*SoftwareRecipe_Step `protobuf:"bytes,4,rep,name=install_steps,json=installSteps,proto3" json:"install_steps,omitempty"`

	UpdateSteps []*SoftwareRecipe_Step `protobuf:"bytes,5,rep,name=update_steps,json=updateSteps,proto3" json:"update_steps,omitempty"`

	DesiredState DesiredState "" /* 159 byte string literal not displayed */

}

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_Artifact

func (*SoftwareRecipe) GetDesiredState

func (x *SoftwareRecipe) GetDesiredState() DesiredState

func (*SoftwareRecipe) GetInstallSteps

func (x *SoftwareRecipe) GetInstallSteps() []*SoftwareRecipe_Step

func (*SoftwareRecipe) GetName

func (x *SoftwareRecipe) GetName() string

func (*SoftwareRecipe) GetUpdateSteps

func (x *SoftwareRecipe) GetUpdateSteps() []*SoftwareRecipe_Step

func (*SoftwareRecipe) GetVersion

func (x *SoftwareRecipe) GetVersion() string

func (*SoftwareRecipe) ProtoMessage

func (*SoftwareRecipe) ProtoMessage()

func (*SoftwareRecipe) ProtoReflect

func (x *SoftwareRecipe) ProtoReflect() protoreflect.Message

func (*SoftwareRecipe) Reset

func (x *SoftwareRecipe) Reset()

func (*SoftwareRecipe) String

func (x *SoftwareRecipe) String() string

SoftwareRecipe_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() bool

func (*SoftwareRecipe_Artifact) GetArtifact

func (m *SoftwareRecipe_Artifact) GetArtifact() isSoftwareRecipe_Artifact_Artifact

func (*SoftwareRecipe_Artifact) GetGcs

func (*SoftwareRecipe_Artifact) GetId

func (x *SoftwareRecipe_Artifact) GetId() string

func (*SoftwareRecipe_Artifact) GetRemote

func (*SoftwareRecipe_Artifact) ProtoMessage

func (*SoftwareRecipe_Artifact) ProtoMessage()

func (*SoftwareRecipe_Artifact) ProtoReflect

func (x *SoftwareRecipe_Artifact) ProtoReflect() protoreflect.Message

func (*SoftwareRecipe_Artifact) Reset

func (x *SoftwareRecipe_Artifact) Reset()

func (*SoftwareRecipe_Artifact) String

func (x *SoftwareRecipe_Artifact) String() string

SoftwareRecipe_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() string

func (*SoftwareRecipe_Artifact_Gcs) GetGeneration

func (x *SoftwareRecipe_Artifact_Gcs) GetGeneration() int64

func (*SoftwareRecipe_Artifact_Gcs) GetObject

func (x *SoftwareRecipe_Artifact_Gcs) GetObject() string

func (*SoftwareRecipe_Artifact_Gcs) ProtoMessage

func (*SoftwareRecipe_Artifact_Gcs) ProtoMessage()

func (*SoftwareRecipe_Artifact_Gcs) ProtoReflect

func (*SoftwareRecipe_Artifact_Gcs) Reset

func (x *SoftwareRecipe_Artifact_Gcs) Reset()

func (*SoftwareRecipe_Artifact_Gcs) String

func (x *SoftwareRecipe_Artifact_Gcs) String() string

SoftwareRecipe_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() string

func (*SoftwareRecipe_Artifact_Remote) GetUri

func (*SoftwareRecipe_Artifact_Remote) ProtoMessage

func (*SoftwareRecipe_Artifact_Remote) ProtoMessage()

func (*SoftwareRecipe_Artifact_Remote) ProtoReflect

func (*SoftwareRecipe_Artifact_Remote) Reset

func (x *SoftwareRecipe_Artifact_Remote) Reset()

func (*SoftwareRecipe_Artifact_Remote) String

SoftwareRecipe_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_ExtractArchive

func (*SoftwareRecipe_Step) GetDpkgInstallation

func (x *SoftwareRecipe_Step) GetDpkgInstallation() *SoftwareRecipe_Step_InstallDpkg

func (*SoftwareRecipe_Step) GetFileCopy

func (*SoftwareRecipe_Step) GetFileExec

func (*SoftwareRecipe_Step) GetMsiInstallation

func (x *SoftwareRecipe_Step) GetMsiInstallation() *SoftwareRecipe_Step_InstallMsi

func (*SoftwareRecipe_Step) GetRpmInstallation

func (x *SoftwareRecipe_Step) GetRpmInstallation() *SoftwareRecipe_Step_InstallRpm

func (*SoftwareRecipe_Step) GetScriptRun

func (*SoftwareRecipe_Step) GetStep

func (m *SoftwareRecipe_Step) GetStep() isSoftwareRecipe_Step_Step

func (*SoftwareRecipe_Step) ProtoMessage

func (*SoftwareRecipe_Step) ProtoMessage()

func (*SoftwareRecipe_Step) ProtoReflect

func (x *SoftwareRecipe_Step) ProtoReflect() protoreflect.Message

func (*SoftwareRecipe_Step) Reset

func (x *SoftwareRecipe_Step) Reset()

func (*SoftwareRecipe_Step) String

func (x *SoftwareRecipe_Step) String() string

SoftwareRecipe_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() string

func (*SoftwareRecipe_Step_CopyFile) GetDestination

func (x *SoftwareRecipe_Step_CopyFile) GetDestination() string

func (*SoftwareRecipe_Step_CopyFile) GetOverwrite

func (x *SoftwareRecipe_Step_CopyFile) GetOverwrite() bool

func (*SoftwareRecipe_Step_CopyFile) GetPermissions

func (x *SoftwareRecipe_Step_CopyFile) GetPermissions() string

func (*SoftwareRecipe_Step_CopyFile) ProtoMessage

func (*SoftwareRecipe_Step_CopyFile) ProtoMessage()

func (*SoftwareRecipe_Step_CopyFile) ProtoReflect

func (*SoftwareRecipe_Step_CopyFile) Reset

func (x *SoftwareRecipe_Step_CopyFile) Reset()

func (*SoftwareRecipe_Step_CopyFile) String

SoftwareRecipe_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() []int32

func (*SoftwareRecipe_Step_ExecFile) GetArgs

func (x *SoftwareRecipe_Step_ExecFile) GetArgs() []string

func (*SoftwareRecipe_Step_ExecFile) GetArtifactId

func (x *SoftwareRecipe_Step_ExecFile) GetArtifactId() string

func (*SoftwareRecipe_Step_ExecFile) GetLocalPath

func (x *SoftwareRecipe_Step_ExecFile) GetLocalPath() string

func (*SoftwareRecipe_Step_ExecFile) GetLocationType

func (m *SoftwareRecipe_Step_ExecFile) GetLocationType() isSoftwareRecipe_Step_ExecFile_LocationType

func (*SoftwareRecipe_Step_ExecFile) ProtoMessage

func (*SoftwareRecipe_Step_ExecFile) ProtoMessage()

func (*SoftwareRecipe_Step_ExecFile) ProtoReflect

func (*SoftwareRecipe_Step_ExecFile) Reset

func (x *SoftwareRecipe_Step_ExecFile) Reset()

func (*SoftwareRecipe_Step_ExecFile) String

SoftwareRecipe_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 {
	ArtifactId string `protobuf:"bytes,1,opt,name=artifact_id,json=artifactId,proto3" json:"artifact_id,omitempty"`

	Destination string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`

	Type SoftwareRecipe_Step_ExtractArchive_ArchiveType "" /* 157 byte string literal not displayed */

}

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() string

func (*SoftwareRecipe_Step_ExtractArchive) GetDestination

func (x *SoftwareRecipe_Step_ExtractArchive) GetDestination() string

func (*SoftwareRecipe_Step_ExtractArchive) GetType

func (*SoftwareRecipe_Step_ExtractArchive) ProtoMessage

func (*SoftwareRecipe_Step_ExtractArchive) ProtoMessage()

func (*SoftwareRecipe_Step_ExtractArchive) ProtoReflect

func (*SoftwareRecipe_Step_ExtractArchive) Reset

func (*SoftwareRecipe_Step_ExtractArchive) String

SoftwareRecipe_Step_ExtractArchive_ArchiveType

type SoftwareRecipe_Step_ExtractArchive_ArchiveType int32

Specifying 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) Enum

func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) EnumDescriptor

Deprecated: Use SoftwareRecipe_Step_ExtractArchive_ArchiveType.Descriptor instead.

func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) Number

func (SoftwareRecipe_Step_ExtractArchive_ArchiveType) String

func (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() string

func (*SoftwareRecipe_Step_InstallDpkg) ProtoMessage

func (*SoftwareRecipe_Step_InstallDpkg) ProtoMessage()

func (*SoftwareRecipe_Step_InstallDpkg) ProtoReflect

func (*SoftwareRecipe_Step_InstallDpkg) Reset

func (*SoftwareRecipe_Step_InstallDpkg) String

SoftwareRecipe_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() []int32

func (*SoftwareRecipe_Step_InstallMsi) GetArtifactId

func (x *SoftwareRecipe_Step_InstallMsi) GetArtifactId() string

func (*SoftwareRecipe_Step_InstallMsi) GetFlags

func (x *SoftwareRecipe_Step_InstallMsi) GetFlags() []string

func (*SoftwareRecipe_Step_InstallMsi) ProtoMessage

func (*SoftwareRecipe_Step_InstallMsi) ProtoMessage()

func (*SoftwareRecipe_Step_InstallMsi) ProtoReflect

func (*SoftwareRecipe_Step_InstallMsi) Reset

func (x *SoftwareRecipe_Step_InstallMsi) Reset()

func (*SoftwareRecipe_Step_InstallMsi) String

SoftwareRecipe_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() string

func (*SoftwareRecipe_Step_InstallRpm) ProtoMessage

func (*SoftwareRecipe_Step_InstallRpm) ProtoMessage()

func (*SoftwareRecipe_Step_InstallRpm) ProtoReflect

func (*SoftwareRecipe_Step_InstallRpm) Reset

func (x *SoftwareRecipe_Step_InstallRpm) Reset()

func (*SoftwareRecipe_Step_InstallRpm) String

SoftwareRecipe_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 {
	Script string `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`

	AllowedExitCodes []int32 `protobuf:"varint,2,rep,packed,name=allowed_exit_codes,json=allowedExitCodes,proto3" json:"allowed_exit_codes,omitempty"`

	Interpreter SoftwareRecipe_Step_RunScript_Interpreter "" /* 166 byte string literal not displayed */

}

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() []int32

func (*SoftwareRecipe_Step_RunScript) GetInterpreter

func (*SoftwareRecipe_Step_RunScript) GetScript

func (x *SoftwareRecipe_Step_RunScript) GetScript() string

func (*SoftwareRecipe_Step_RunScript) ProtoMessage

func (*SoftwareRecipe_Step_RunScript) ProtoMessage()

func (*SoftwareRecipe_Step_RunScript) ProtoReflect

func (*SoftwareRecipe_Step_RunScript) Reset

func (x *SoftwareRecipe_Step_RunScript) Reset()

func (*SoftwareRecipe_Step_RunScript) String

SoftwareRecipe_Step_RunScript_Interpreter

type SoftwareRecipe_Step_RunScript_Interpreter int32

The 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) Enum

func (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 (SoftwareRecipe_Step_RunScript_Interpreter) String

func (SoftwareRecipe_Step_RunScript_Interpreter) Type

SoftwareRecipe_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() string

func (*StartNextTaskRequest) ProtoMessage

func (*StartNextTaskRequest) ProtoMessage()

func (*StartNextTaskRequest) ProtoReflect

func (x *StartNextTaskRequest) ProtoReflect() protoreflect.Message

func (*StartNextTaskRequest) Reset

func (x *StartNextTaskRequest) Reset()

func (*StartNextTaskRequest) String

func (x *StartNextTaskRequest) String() string

StartNextTaskResponse

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() *Task

func (*StartNextTaskResponse) ProtoMessage

func (*StartNextTaskResponse) ProtoMessage()

func (*StartNextTaskResponse) ProtoReflect

func (x *StartNextTaskResponse) ProtoReflect() protoreflect.Message

func (*StartNextTaskResponse) Reset

func (x *StartNextTaskResponse) Reset()

func (*StartNextTaskResponse) String

func (x *StartNextTaskResponse) String() string

Task

type Task struct {
	TaskId string `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`

	TaskType TaskType "" /* 143 byte string literal not displayed */

	TaskDirective TaskDirective "" /* 163 byte string literal not displayed */

	TaskDetails isTask_TaskDetails `protobuf_oneof:"task_details"`

	ServiceLabels map[string]string "" /* 188 byte string literal not displayed */

}

A unit of work to be performed by the agent.

func (*Task) Descriptor

func (*Task) Descriptor() ([]byte, []int)

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetApplyPatchesTask

func (x *Task) GetApplyPatchesTask() *ApplyPatchesTask

func (*Task) GetExecStepTask

func (x *Task) GetExecStepTask() *ExecStepTask

func (*Task) GetServiceLabels

func (x *Task) GetServiceLabels() map[string]string

func (*Task) GetTaskDetails

func (m *Task) GetTaskDetails() isTask_TaskDetails

func (*Task) GetTaskDirective

func (x *Task) GetTaskDirective() TaskDirective

func (*Task) GetTaskId

func (x *Task) GetTaskId() string

func (*Task) GetTaskType

func (x *Task) GetTaskType() TaskType

func (*Task) ProtoMessage

func (*Task) ProtoMessage()

func (*Task) ProtoReflect

func (x *Task) ProtoReflect() protoreflect.Message

func (*Task) Reset

func (x *Task) Reset()

func (*Task) String

func (x *Task) String() string

TaskDirective

type TaskDirective int32

Specifies 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) Enum

func (x TaskDirective) Enum() *TaskDirective

func (TaskDirective) EnumDescriptor

func (TaskDirective) EnumDescriptor() ([]byte, []int)

Deprecated: Use TaskDirective.Descriptor instead.

func (TaskDirective) Number

func (TaskDirective) String

func (x TaskDirective) String() string

func (TaskDirective) Type

TaskType

type TaskType int32

Specifies 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.EnumDescriptor

func (TaskType) Enum

func (x TaskType) Enum() *TaskType

func (TaskType) EnumDescriptor

func (TaskType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TaskType.Descriptor instead.

func (TaskType) Number

func (x TaskType) Number() protoreflect.EnumNumber

func (TaskType) String

func (x TaskType) String() string

func (TaskType) Type

Task_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 can be embedded to have forward compatible implementations.

func (*UnimplementedAgentEndpointServiceServer) LookupEffectiveGuestPolicy

func (*UnimplementedAgentEndpointServiceServer) ReceiveTaskNotification

func (*UnimplementedAgentEndpointServiceServer) RegisterAgent

func (*UnimplementedAgentEndpointServiceServer) ReportTaskComplete

func (*UnimplementedAgentEndpointServiceServer) ReportTaskProgress

func (*UnimplementedAgentEndpointServiceServer) StartNextTask

WindowsUpdateSettings

type WindowsUpdateSettings struct {
	Classifications []WindowsUpdateSettings_Classification "" /* 176 byte string literal not displayed */

	Excludes []string `protobuf:"bytes,2,rep,name=excludes,proto3" json:"excludes,omitempty"`

	ExclusivePatches []string `protobuf:"bytes,3,rep,name=exclusive_patches,json=exclusivePatches,proto3" json:"exclusive_patches,omitempty"`

}

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 (*WindowsUpdateSettings) GetExcludes

func (x *WindowsUpdateSettings) GetExcludes() []string

func (*WindowsUpdateSettings) GetExclusivePatches

func (x *WindowsUpdateSettings) GetExclusivePatches() []string

func (*WindowsUpdateSettings) ProtoMessage

func (*WindowsUpdateSettings) ProtoMessage()

func (*WindowsUpdateSettings) ProtoReflect

func (x *WindowsUpdateSettings) ProtoReflect() protoreflect.Message

func (*WindowsUpdateSettings) Reset

func (x *WindowsUpdateSettings) Reset()

func (*WindowsUpdateSettings) String

func (x *WindowsUpdateSettings) String() string

WindowsUpdateSettings_Classification

type WindowsUpdateSettings_Classification int32

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) Enum

func (WindowsUpdateSettings_Classification) EnumDescriptor

func (WindowsUpdateSettings_Classification) EnumDescriptor() ([]byte, []int)

Deprecated: Use WindowsUpdateSettings_Classification.Descriptor instead.

func (WindowsUpdateSettings_Classification) Number

func (WindowsUpdateSettings_Classification) String

func (WindowsUpdateSettings_Classification) Type

YumRepository

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() string

func (*YumRepository) GetDisplayName

func (x *YumRepository) GetDisplayName() string

func (*YumRepository) GetGpgKeys

func (x *YumRepository) GetGpgKeys() []string

func (*YumRepository) GetId

func (x *YumRepository) GetId() string

func (*YumRepository) ProtoMessage

func (*YumRepository) ProtoMessage()

func (*YumRepository) ProtoReflect

func (x *YumRepository) ProtoReflect() protoreflect.Message

func (*YumRepository) Reset

func (x *YumRepository) Reset()

func (*YumRepository) String

func (x *YumRepository) String() string

YumSettings

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() []string

func (*YumSettings) GetExclusivePackages

func (x *YumSettings) GetExclusivePackages() []string

func (*YumSettings) GetMinimal

func (x *YumSettings) GetMinimal() bool

func (*YumSettings) GetSecurity

func (x *YumSettings) GetSecurity() bool

func (*YumSettings) ProtoMessage

func (*YumSettings) ProtoMessage()

func (*YumSettings) ProtoReflect

func (x *YumSettings) ProtoReflect() protoreflect.Message

func (*YumSettings) Reset

func (x *YumSettings) Reset()

func (*YumSettings) String

func (x *YumSettings) String() string

ZypperRepository

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() string

func (*ZypperRepository) GetDisplayName

func (x *ZypperRepository) GetDisplayName() string

func (*ZypperRepository) GetGpgKeys

func (x *ZypperRepository) GetGpgKeys() []string

func (*ZypperRepository) GetId

func (x *ZypperRepository) GetId() string

func (*ZypperRepository) ProtoMessage

func (*ZypperRepository) ProtoMessage()

func (*ZypperRepository) ProtoReflect

func (x *ZypperRepository) ProtoReflect() protoreflect.Message

func (*ZypperRepository) Reset

func (x *ZypperRepository) Reset()

func (*ZypperRepository) String

func (x *ZypperRepository) String() string

ZypperSettings

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() []string

func (*ZypperSettings) GetExcludes

func (x *ZypperSettings) GetExcludes() []string

func (*ZypperSettings) GetExclusivePatches

func (x *ZypperSettings) GetExclusivePatches() []string

func (*ZypperSettings) GetSeverities

func (x *ZypperSettings) GetSeverities() []string

func (*ZypperSettings) GetWithOptional

func (x *ZypperSettings) GetWithOptional() bool

func (*ZypperSettings) GetWithUpdate

func (x *ZypperSettings) GetWithUpdate() bool

func (*ZypperSettings) ProtoMessage

func (*ZypperSettings) ProtoMessage()

func (*ZypperSettings) ProtoReflect

func (x *ZypperSettings) ProtoReflect() protoreflect.Message

func (*ZypperSettings) Reset

func (x *ZypperSettings) Reset()

func (*ZypperSettings) String

func (x *ZypperSettings) String() string