Cloud OS Config V1 API - Class Google::Cloud::OsConfig::V1::OSPolicyAssignment (v0.12.0)

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

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#baseline

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

def deleted() -> ::Boolean
Returns
  • (::Boolean) — Output only. Indicates that this revision deletes the OS policy assignment.

#description

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

#description=

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

#etag

def etag() -> ::String
Returns
  • (::String) — The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.
Returns
  • (::String) — The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.

#instance_filter

def instance_filter() -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignment::InstanceFilter
Returns

#instance_filter=

def instance_filter=(value) -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignment::InstanceFilter
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Resource name.

    Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}

    This field is ignored when you create an OS policy assignment.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Resource name.

    Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}

    This field is ignored when you create an OS policy assignment.

Returns
  • (::String) — Resource name.

    Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}

    This field is ignored when you create an OS policy assignment.

#os_policies

def os_policies() -> ::Array<::Google::Cloud::OsConfig::V1::OSPolicy>
Returns

#os_policies=

def os_policies=(value) -> ::Array<::Google::Cloud::OsConfig::V1::OSPolicy>
Parameter
Returns

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) —

    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

#revision_create_time

def revision_create_time() -> ::Google::Protobuf::Timestamp
Returns

#revision_id

def revision_id() -> ::String
Returns
  • (::String) — Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment

#rollout

def rollout() -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignment::Rollout
Returns
  • (::Google::Cloud::OsConfig::V1::OSPolicyAssignment::Rollout) —

    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.

#rollout=

def rollout=(value) -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignment::Rollout
Parameter
  • value (::Google::Cloud::OsConfig::V1::OSPolicyAssignment::Rollout) —

    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.
Returns
  • (::Google::Cloud::OsConfig::V1::OSPolicyAssignment::Rollout) —

    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.

#rollout_state

def rollout_state() -> ::Google::Cloud::OsConfig::V1::OSPolicyAssignment::RolloutState
Returns

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Server generated unique id for the OS policy assignment resource.