Package com.google.cloud.osconfig.v1

Interface OSPolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    OSPolicy, OSPolicy.Builder
    public interface OSPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        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];
        Returns:
        The id.

      • getIdBytes

        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];
        Returns:
        The bytes for id.

      • getDescription

        String getDescription()
         Policy description.
 Length of the description is limited to 1024 characters.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Policy description.
 Length of the description is limited to 1024 characters.
        string description = 2;
        Returns:
        The bytes for description.

      • getModeValue

        int getModeValue()
         Required. Policy mode
        .google.cloud.osconfig.v1.OSPolicy.Mode mode = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The enum numeric value on the wire for mode.

      • getMode

        OSPolicy.Mode getMode()
         Required. Policy mode
        .google.cloud.osconfig.v1.OSPolicy.Mode mode = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The mode.

      • getResourceGroupsList

        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.v1.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];

      • getResourceGroups

        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.v1.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];

      • getResourceGroupsCount

        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.v1.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];

      • getResourceGroupsOrBuilderList

        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.v1.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];

      • getResourceGroupsOrBuilder

        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.v1.OSPolicy.ResourceGroup resource_groups = 4 [(.google.api.field_behavior) = REQUIRED];

      • getAllowNoResourceGroupMatch

        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;
        Returns:
        The allowNoResourceGroupMatch.