Reference documentation and code samples for the Cloud OS Config V1alpha API class Google::Cloud::OsConfig::V1alpha::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
-
(::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
- (::Boolean) — Output only. Indicates that this revision deletes the OS policy assignment.
#description
def description() -> ::String
- (::String) — OS policy assignment description. Length of the description is limited to 1024 characters.
#description=
def description=(value) -> ::String
- value (::String) — OS policy assignment description. Length of the description is limited to 1024 characters.
- (::String) — OS policy assignment description. Length of the description is limited to 1024 characters.
#etag
def etag() -> ::String
- (::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
- value (::String) — The etag for this OS policy assignment. If this is provided on update, it must match the server's etag.
- (::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::V1alpha::OSPolicyAssignment::InstanceFilter
- (::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::InstanceFilter) — Required. Filter to select VMs.
#instance_filter=
def instance_filter=(value) -> ::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::InstanceFilter
- value (::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::InstanceFilter) — Required. Filter to select VMs.
- (::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::InstanceFilter) — Required. Filter to select VMs.
#name
def name() -> ::String
-
(::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
-
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.
-
(::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::V1alpha::OSPolicy>
- (::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy>) — Required. List of OS policies to be applied to the VMs.
#os_policies=
def os_policies=(value) -> ::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy>
- value (::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy>) — Required. List of OS policies to be applied to the VMs.
- (::Array<::Google::Cloud::OsConfig::V1alpha::OSPolicy>) — Required. List of OS policies to be applied to the VMs.
#reconciling
def reconciling() -> ::Boolean
-
(::Boolean) —
Output only. Indicates that reconciliation is in progress for the revision. This value is
true
when therollout_state
is one of:- IN_PROGRESS
- CANCELLING
#revision_create_time
def revision_create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The timestamp that the revision was created.
#revision_id
def revision_id() -> ::String
- (::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::V1alpha::OSPolicyAssignment::Rollout
-
(::Google::Cloud::OsConfig::V1alpha::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::V1alpha::OSPolicyAssignment::Rollout
-
value (::Google::Cloud::OsConfig::V1alpha::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.
-
(::Google::Cloud::OsConfig::V1alpha::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::V1alpha::OSPolicyAssignment::RolloutState
- (::Google::Cloud::OsConfig::V1alpha::OSPolicyAssignment::RolloutState) — Output only. OS policy assignment rollout state
#uid
def uid() -> ::String
- (::String) — Output only. Server generated unique id for the OS policy assignment resource.