Google Cloud OsConfig V1 Client - Class OSPolicyAssignmentReport (2.0.0)

Reference documentation and code samples for the Google Cloud OsConfig V1 Client class OSPolicyAssignmentReport.

A report of the OS policy assignment status for a given instance.

Generated from protobuf message google.cloud.osconfig.v1.OSPolicyAssignmentReport

Namespace

Google \ Cloud \ OsConfig \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The `OSPolicyAssignmentReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report`
`↳ instance`	`string` The Compute Engine VM instance name.
`↳ os_policy_assignment`	`string` Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
`↳ os_policy_compliances`	`array<Google\Cloud\OsConfig\V1\OSPolicyAssignmentReport\OSPolicyCompliance>` Compliance data for each `OSPolicy` that is applied to the VM.
`↳ update_time`	`Google\Protobuf\Timestamp` Timestamp for when the report was last generated.
`↳ last_run_id`	`string` Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs.

getName

The OSPolicyAssignmentReport API resource name.

Format: projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report

Returns
Type	Description
`string`

setName

The OSPolicyAssignmentReport API resource name.

Format: projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstance

The Compute Engine VM instance name.

Returns
Type	Description
`string`

setInstance

The Compute Engine VM instance name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOsPolicyAssignment

Reference to the OSPolicyAssignment API resource that the OSPolicy belongs to.

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

Returns
Type	Description
`string`

setOsPolicyAssignment

Reference to the OSPolicyAssignment API resource that the OSPolicy belongs to.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOsPolicyCompliances

Compliance data for each OSPolicy that is applied to the VM.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setOsPolicyCompliances

Compliance data for each OSPolicy that is applied to the VM.

Parameter
Name	Description
`var`	`array<Google\Cloud\OsConfig\V1\OSPolicyAssignmentReport\OSPolicyCompliance>`

Returns
Type	Description
`$this`

getUpdateTime

Timestamp for when the report was last generated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Timestamp for when the report was last generated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLastRunId

Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM.

This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs.

Returns
Type	Description
`string`

setLastRunId

Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`