View Source GoogleApi.OSConfig.V1.Model.OSPolicyAssignment (google_api_os_config v0.20.0)

OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see OS policy and OS policy assignment.


  • baseline (type: boolean(), default: nil) - Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of true for this field.
  • deleted (type: boolean(), default: nil) - Output only. Indicates that this revision deletes the OS policy assignment.
  • description (type: String.t, default: nil) - OS policy assignment description. Length of the description is limited to 1024 characters.
  • etag (type: String.t, default: nil) - The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.
  • instanceFilter (type: GoogleApi.OSConfig.V1.Model.OSPolicyAssignmentInstanceFilter.t, default: nil) - Required. Filter to select VMs.
  • name (type: String.t, default: nil) - Resource name. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id} This field is ignored when you create an OS policy assignment.
  • osPolicies (type: list(GoogleApi.OSConfig.V1.Model.OSPolicy.t), default: nil) - Required. List of OS policies to be applied to the VMs.
  • reconciling (type: boolean(), default: nil) - Output only. Indicates that reconciliation is in progress for the revision. This value is true when the rollout_state is one of: IN_PROGRESS CANCELLING
  • revisionCreateTime (type: DateTime.t, default: nil) - Output only. The timestamp that the revision was created.
  • revisionId (type: String.t, default: nil) - Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment
  • rollout (type: GoogleApi.OSConfig.V1.Model.OSPolicyAssignmentRollout.t, default: nil) - Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted.
  • rolloutState (type: String.t, default: nil) - Output only. OS policy assignment rollout state
  • uid (type: String.t, default: nil) - Output only. Server generated unique id for the OS policy assignment resource.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.OSConfig.V1.Model.OSPolicyAssignment{
  baseline: boolean() | nil,
  deleted: boolean() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
    GoogleApi.OSConfig.V1.Model.OSPolicyAssignmentInstanceFilter.t() | nil,
  name: String.t() | nil,
  osPolicies: [GoogleApi.OSConfig.V1.Model.OSPolicy.t()] | nil,
  reconciling: boolean() | nil,
  revisionCreateTime: DateTime.t() | nil,
  revisionId: String.t() | nil,
  rollout: GoogleApi.OSConfig.V1.Model.OSPolicyAssignmentRollout.t() | nil,
  rolloutState: String.t() | nil,
  uid: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.