Cloud OS Config V1alpha API - Class Google::Cloud::OsConfig::V1alpha::OSPolicy (v0.8.2)

Reference documentation and code samples for the Cloud OS Config V1alpha API class Google::Cloud::OsConfig::V1alpha::OSPolicy.

An OS policy defines the desired state configuration for a VM.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_no_resource_group_match

def allow_no_resource_group_match() -> ::Boolean
Returns
  • (::Boolean) — 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.

#allow_no_resource_group_match=

def allow_no_resource_group_match=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#description

def description() -> ::String
Returns
  • (::String) — Policy description. Length of the description is limited to 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Policy description. Length of the description is limited to 1024 characters.
Returns
  • (::String) — Policy description. Length of the description is limited to 1024 characters.

#id

def id() -> ::String
Returns
  • (::String) —

    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.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) —

    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.
Returns
  • (::String) —

    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.

#mode

def mode() -> ::Google::Cloud::OsConfig::V1alpha::OSPolicy::Mode
Returns

#mode=

def mode=(value) -> ::Google::Cloud::OsConfig::V1alpha::OSPolicy::Mode
Parameter
Returns

#resource_groups

def resource_groups() -> ::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy::ResourceGroup>
Returns
  • (::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy::ResourceGroup>) — 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

#resource_groups=

def resource_groups=(value) -> ::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy::ResourceGroup>
Parameter
  • value (::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy::ResourceGroup>) — 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

Returns
  • (::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy::ResourceGroup>) — 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