Class GuestPolicies.Package (2.38.0)

public static final class GuestPolicies.Package extends GeneratedMessageV3 implements GuestPolicies.PackageOrBuilder

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

Protobuf type google.cloud.osconfig.v1beta.Package

Static Fields

DESIRED_STATE_FIELD_NUMBER

public static final int DESIRED_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

MANAGER_FIELD_NUMBER

public static final int MANAGER_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GuestPolicies.Package getDefaultInstance()
Returns
TypeDescription
GuestPolicies.Package

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GuestPolicies.Package.Builder newBuilder()
Returns
TypeDescription
GuestPolicies.Package.Builder

newBuilder(GuestPolicies.Package prototype)

public static GuestPolicies.Package.Builder newBuilder(GuestPolicies.Package prototype)
Parameter
NameDescription
prototypeGuestPolicies.Package
Returns
TypeDescription
GuestPolicies.Package.Builder

parseDelimitedFrom(InputStream input)

public static GuestPolicies.Package parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.Package parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GuestPolicies.Package parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.Package parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GuestPolicies.Package parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.Package parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GuestPolicies.Package parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.Package parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GuestPolicies.Package parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.Package parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GuestPolicies.Package parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.Package parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.Package
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GuestPolicies.Package> parser()
Returns
TypeDescription
Parser<Package>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public GuestPolicies.Package getDefaultInstanceForType()
Returns
TypeDescription
GuestPolicies.Package

getDesiredState()

public GuestPolicies.DesiredState getDesiredState()

The desired_state the agent should maintain for this package. The default is to ensure the package is installed.

.google.cloud.osconfig.v1beta.DesiredState desired_state = 2;

Returns
TypeDescription
GuestPolicies.DesiredState

The desiredState.

getDesiredStateValue()

public int getDesiredStateValue()

The desired_state the agent should maintain for this package. The default is to ensure the package is installed.

.google.cloud.osconfig.v1beta.DesiredState desired_state = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for desiredState.

getManager()

public GuestPolicies.Package.Manager getManager()

Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify ANY, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems.

The default behavior is ANY.

.google.cloud.osconfig.v1beta.Package.Manager manager = 3;

Returns
TypeDescription
GuestPolicies.Package.Manager

The manager.

getManagerValue()

public int getManagerValue()

Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify ANY, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems.

The default behavior is ANY.

.google.cloud.osconfig.v1beta.Package.Manager manager = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for manager.

getName()

public String getName()

Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<GuestPolicies.Package> getParserForType()
Returns
TypeDescription
Parser<Package>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GuestPolicies.Package.Builder newBuilderForType()
Returns
TypeDescription
GuestPolicies.Package.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GuestPolicies.Package.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GuestPolicies.Package.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GuestPolicies.Package.Builder toBuilder()
Returns
TypeDescription
GuestPolicies.Package.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException