Class: Google::Apis::OsconfigV2::OsPolicy

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/osconfig_v2/classes.rb,
lib/google/apis/osconfig_v2/representations.rb,
lib/google/apis/osconfig_v2/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OsPolicy

Returns a new instance of OsPolicy.



711
712
713
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 711

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_no_resource_group_match ⇒ Boolean Also known as: allow_no_resource_group_match?

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. Corresponds to the JSON property allowNoResourceGroupMatch

Returns:

  • (Boolean) 


680
681
682
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 680

def allow_no_resource_group_match
  @allow_no_resource_group_match
end

#description ⇒ String

Policy description. Length of the description is limited to 1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


686
687
688
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 686

def description
  @description
end

#id ⇒ 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. Corresponds to the JSON property id

Returns:

  • (String) 


694
695
696
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 694

def id
  @id
end

#mode ⇒ String

Required. Policy mode Corresponds to the JSON property mode

Returns:

  • (String) 


699
700
701
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 699

def mode
  @mode
end

#resource_groups ⇒ Array<Google::Apis::OsconfigV2::OsPolicyResourceGroup>

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 Corresponds to the JSON property resourceGroups

Returns:



709
710
711
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 709

def resource_groups
  @resource_groups
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



716
717
718
719
720
721
722
 
# File 'lib/google/apis/osconfig_v2/classes.rb', line 716

def update!(**args)
  @allow_no_resource_group_match = args[:allow_no_resource_group_match] if args.key?(:allow_no_resource_group_match)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @mode = args[:mode] if args.key?(:mode)
  @resource_groups = args[:resource_groups] if args.key?(:resource_groups)
end