Class OSPolicy
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.osconfig.v1alpha.OSPolicy
-
- All Implemented Interfaces:
OSPolicyOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class OSPolicy extends com.google.protobuf.GeneratedMessageV3 implements OSPolicyOrBuilder
An OS policy defines the desired state configuration for a VM.
Protobuf typegoogle.cloud.osconfig.v1alpha.OSPolicy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OSPolicy.Builder
An OS policy defines the desired state configuration for a VM.static class
OSPolicy.InventoryFilter
Filtering criteria to select VMs based on inventory details.static interface
OSPolicy.InventoryFilterOrBuilder
static class
OSPolicy.Mode
Policy modestatic class
OSPolicy.OSFilter
Filtering criteria to select VMs based on OS details.static interface
OSPolicy.OSFilterOrBuilder
static class
OSPolicy.Resource
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.static class
OSPolicy.ResourceGroup
Resource groups provide a mechanism to group OS policy resources.static interface
OSPolicy.ResourceGroupOrBuilder
static interface
OSPolicy.ResourceOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALLOW_NO_RESOURCE_GROUP_MATCH_FIELD_NUMBER
static int
DESCRIPTION_FIELD_NUMBER
static int
ID_FIELD_NUMBER
static int
MODE_FIELD_NUMBER
static int
RESOURCE_GROUPS_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
boolean
getAllowNoResourceGroupMatch()
This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM.static OSPolicy
getDefaultInstance()
OSPolicy
getDefaultInstanceForType()
String
getDescription()
Policy description.com.google.protobuf.ByteString
getDescriptionBytes()
Policy description.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getId()
Required.com.google.protobuf.ByteString
getIdBytes()
Required.OSPolicy.Mode
getMode()
Required.int
getModeValue()
Required.com.google.protobuf.Parser<OSPolicy>
getParserForType()
OSPolicy.ResourceGroup
getResourceGroups(int index)
Required.int
getResourceGroupsCount()
Required.List<OSPolicy.ResourceGroup>
getResourceGroupsList()
Required.OSPolicy.ResourceGroupOrBuilder
getResourceGroupsOrBuilder(int index)
Required.List<? extends OSPolicy.ResourceGroupOrBuilder>
getResourceGroupsOrBuilderList()
Required.int
getSerializedSize()
int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static OSPolicy.Builder
newBuilder()
static OSPolicy.Builder
newBuilder(OSPolicy prototype)
OSPolicy.Builder
newBuilderForType()
protected OSPolicy.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static OSPolicy
parseDelimitedFrom(InputStream input)
static OSPolicy
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OSPolicy
parseFrom(byte[] data)
static OSPolicy
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OSPolicy
parseFrom(com.google.protobuf.ByteString data)
static OSPolicy
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OSPolicy
parseFrom(com.google.protobuf.CodedInputStream input)
static OSPolicy
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OSPolicy
parseFrom(InputStream input)
static OSPolicy
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OSPolicy
parseFrom(ByteBuffer data)
static OSPolicy
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OSPolicy>
parser()
OSPolicy.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODE_FIELD_NUMBER
public static final int MODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RESOURCE_GROUPS_FIELD_NUMBER
public static final int RESOURCE_GROUPS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ALLOW_NO_RESOURCE_GROUP_MATCH_FIELD_NUMBER
public static final int ALLOW_NO_RESOURCE_GROUP_MATCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getId
public String getId()
Required. The id of the OS policy 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 assignment.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getId
in interfaceOSPolicyOrBuilder
- Returns:
- The id.
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
Required. The id of the OS policy 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 assignment.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getIdBytes
in interfaceOSPolicyOrBuilder
- Returns:
- The bytes for id.
-
getDescription
public String getDescription()
Policy description. Length of the description is limited to 1024 characters.
string description = 2;
- Specified by:
getDescription
in interfaceOSPolicyOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Policy description. Length of the description is limited to 1024 characters.
string description = 2;
- Specified by:
getDescriptionBytes
in interfaceOSPolicyOrBuilder
- Returns:
- The bytes for description.
-
getModeValue
public int getModeValue()
Required. Policy mode
.google.cloud.osconfig.v1alpha.OSPolicy.Mode mode = 3 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getModeValue
in interfaceOSPolicyOrBuilder
- Returns:
- The enum numeric value on the wire for mode.
-
getMode
public OSPolicy.Mode getMode()
Required. Policy mode
.google.cloud.osconfig.v1alpha.OSPolicy.Mode mode = 3 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getMode
in interfaceOSPolicyOrBuilder
- Returns:
- The mode.
-
getResourceGroupsList
public List<OSPolicy.ResourceGroup> getResourceGroupsList()
Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`
repeated .google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getResourceGroupsList
in interfaceOSPolicyOrBuilder
-
getResourceGroupsOrBuilderList
public List<? extends OSPolicy.ResourceGroupOrBuilder> getResourceGroupsOrBuilderList()
Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`
repeated .google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getResourceGroupsOrBuilderList
in interfaceOSPolicyOrBuilder
-
getResourceGroupsCount
public int getResourceGroupsCount()
Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`
repeated .google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getResourceGroupsCount
in interfaceOSPolicyOrBuilder
-
getResourceGroups
public OSPolicy.ResourceGroup getResourceGroups(int index)
Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`
repeated .google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getResourceGroups
in interfaceOSPolicyOrBuilder
-
getResourceGroupsOrBuilder
public OSPolicy.ResourceGroupOrBuilder getResourceGroupsOrBuilder(int index)
Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`
repeated .google.cloud.osconfig.v1alpha.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getResourceGroupsOrBuilder
in interfaceOSPolicyOrBuilder
-
getAllowNoResourceGroupMatch
public boolean getAllowNoResourceGroupMatch()
This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce.
bool allow_no_resource_group_match = 5;
- Specified by:
getAllowNoResourceGroupMatch
in interfaceOSPolicyOrBuilder
- Returns:
- The allowNoResourceGroupMatch.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static OSPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OSPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OSPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OSPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OSPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OSPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OSPolicy parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static OSPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static OSPolicy parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static OSPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static OSPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static OSPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public OSPolicy.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static OSPolicy.Builder newBuilder()
-
newBuilder
public static OSPolicy.Builder newBuilder(OSPolicy prototype)
-
toBuilder
public OSPolicy.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected OSPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static OSPolicy getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<OSPolicy> parser()
-
getParserForType
public com.google.protobuf.Parser<OSPolicy> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public OSPolicy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-