Class OSPolicy.Resource (2.24.0)

public static final class OSPolicy.Resource extends GeneratedMessageV3 implements OSPolicy.ResourceOrBuilder

An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc.

The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

Protobuf type google.cloud.osconfig.v1alpha.OSPolicy.Resource

Static Fields

EXEC_FIELD_NUMBER

public static final int EXEC_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_FIELD_NUMBER

public static final int FILE_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

PKG_FIELD_NUMBER

public static final int PKG_FIELD_NUMBER
Field Value
TypeDescription
int

REPOSITORY_FIELD_NUMBER

public static final int REPOSITORY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OSPolicy.Resource getDefaultInstance()
Returns
TypeDescription
OSPolicy.Resource

getDescriptor()

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

newBuilder()

public static OSPolicy.Resource.Builder newBuilder()
Returns
TypeDescription
OSPolicy.Resource.Builder

newBuilder(OSPolicy.Resource prototype)

public static OSPolicy.Resource.Builder newBuilder(OSPolicy.Resource prototype)
Parameter
NameDescription
prototypeOSPolicy.Resource
Returns
TypeDescription
OSPolicy.Resource.Builder

parseDelimitedFrom(InputStream input)

public static OSPolicy.Resource parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OSPolicy.Resource
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static OSPolicy.Resource parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OSPolicy.Resource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static OSPolicy.Resource parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OSPolicy.Resource
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static OSPolicy.Resource parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OSPolicy.Resource
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static OSPolicy.Resource parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OSPolicy.Resource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<OSPolicy.Resource> parser()
Returns
TypeDescription
Parser<Resource>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public OSPolicy.Resource getDefaultInstanceForType()
Returns
TypeDescription
OSPolicy.Resource

getExec()

public OSPolicy.Resource.ExecResource getExec()

Exec resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource exec = 4;

Returns
TypeDescription
OSPolicy.Resource.ExecResource

The exec.

getExecOrBuilder()

public OSPolicy.Resource.ExecResourceOrBuilder getExecOrBuilder()

Exec resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource exec = 4;

Returns
TypeDescription
OSPolicy.Resource.ExecResourceOrBuilder

getFile()

public OSPolicy.Resource.FileResource getFile()

File resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource file = 5;

Returns
TypeDescription
OSPolicy.Resource.FileResource

The file.

getFileOrBuilder()

public OSPolicy.Resource.FileResourceOrBuilder getFileOrBuilder()

File resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource file = 5;

Returns
TypeDescription
OSPolicy.Resource.FileResourceOrBuilder

getId()

public String getId()

Required. The id of the resource with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the OS policy.

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

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

Required. The id of the resource with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the OS policy.

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

Returns
TypeDescription
ByteString

The bytes for id.

getParserForType()

public Parser<OSPolicy.Resource> getParserForType()
Returns
TypeDescription
Parser<Resource>
Overrides

getPkg()

public OSPolicy.Resource.PackageResource getPkg()

Package resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource pkg = 2;

Returns
TypeDescription
OSPolicy.Resource.PackageResource

The pkg.

getPkgOrBuilder()

public OSPolicy.Resource.PackageResourceOrBuilder getPkgOrBuilder()

Package resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource pkg = 2;

Returns
TypeDescription
OSPolicy.Resource.PackageResourceOrBuilder

getRepository()

public OSPolicy.Resource.RepositoryResource getRepository()

Package repository resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource repository = 3;

Returns
TypeDescription
OSPolicy.Resource.RepositoryResource

The repository.

getRepositoryOrBuilder()

public OSPolicy.Resource.RepositoryResourceOrBuilder getRepositoryOrBuilder()

Package repository resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource repository = 3;

Returns
TypeDescription
OSPolicy.Resource.RepositoryResourceOrBuilder

getResourceTypeCase()

public OSPolicy.Resource.ResourceTypeCase getResourceTypeCase()
Returns
TypeDescription
OSPolicy.Resource.ResourceTypeCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasExec()

public boolean hasExec()

Exec resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.ExecResource exec = 4;

Returns
TypeDescription
boolean

Whether the exec field is set.

hasFile()

public boolean hasFile()

File resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.FileResource file = 5;

Returns
TypeDescription
boolean

Whether the file field is set.

hasPkg()

public boolean hasPkg()

Package resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.PackageResource pkg = 2;

Returns
TypeDescription
boolean

Whether the pkg field is set.

hasRepository()

public boolean hasRepository()

Package repository resource

.google.cloud.osconfig.v1alpha.OSPolicy.Resource.RepositoryResource repository = 3;

Returns
TypeDescription
boolean

Whether the repository field is set.

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 OSPolicy.Resource.Builder newBuilderForType()
Returns
TypeDescription
OSPolicy.Resource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OSPolicy.Resource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
OSPolicy.Resource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public OSPolicy.Resource.Builder toBuilder()
Returns
TypeDescription
OSPolicy.Resource.Builder

writeTo(CodedOutputStream output)

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