Interface OSPolicyOrBuilder (2.43.0)

Version 2.43.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.6
• 2.4.3
• 2.3.2

public interface OSPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowNoResourceGroupMatch()

public abstract 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
Type	Description
boolean	The allowNoResourceGroupMatch.

getDescription()

public abstract String getDescription()

Policy description. Length of the description is limited to 1024 characters.

string description = 2;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Policy description. Length of the description is limited to 1024 characters.

string description = 2;

Returns
Type	Description
ByteString	The bytes for description.

getId()

public abstract 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
Type	Description
String	The id.

getIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for id.

getMode()

public abstract OSPolicy.Mode getMode()

Required. Policy mode

.google.cloud.osconfig.v1.OSPolicy.Mode mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
OSPolicy.Mode	The mode.

getModeValue()

public abstract int getModeValue()

Required. Policy mode

.google.cloud.osconfig.v1.OSPolicy.Mode mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for mode.

getResourceGroups(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
OSPolicy.ResourceGroup

getResourceGroupsCount()

public abstract 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];

Returns
Type	Description
int

getResourceGroupsList()

public abstract 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];

Returns
Type	Description
List<ResourceGroup>

getResourceGroupsOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
OSPolicy.ResourceGroupOrBuilder

getResourceGroupsOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.osconfig.v1.OSPolicy.ResourceGroupOrBuilder>