Reference documentation and code samples for the Cloud OS Config V1 API class Google::Cloud::OsConfig::V1::ListOSPolicyAssignmentReportsRequest.
List the OS policy assignment reports for VM instances.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) — If provided, this field specifies the criteria that must be met by the
OSPolicyAssignmentReport API resource that is included in the response.
#filter=
deffilter=(value)->::String
Parameter
value (::String) — If provided, this field specifies the criteria that must be met by the
OSPolicyAssignmentReport API resource that is included in the response.
Returns
(::String) — If provided, this field specifies the criteria that must be met by the
OSPolicyAssignmentReport API resource that is included in the response.
#page_size
defpage_size()->::Integer
Returns
(::Integer) — The maximum number of results to return.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — The maximum number of results to return.
Returns
(::Integer) — The maximum number of results to return.
#page_token
defpage_token()->::String
Returns
(::String) — A pagination token returned from a previous call to the
ListOSPolicyAssignmentReports method that indicates where this listing
should continue from.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — A pagination token returned from a previous call to the
ListOSPolicyAssignmentReports method that indicates where this listing
should continue from.
Returns
(::String) — A pagination token returned from a previous call to the
ListOSPolicyAssignmentReports method that indicates where this listing
should continue from.
For {project}, either project-number or project-id can be provided.
For {instance}, either instance-name, instance-id, or - can be
provided. If '-' is provided, the response will include
OSPolicyAssignmentReports for all instances in the project/location.
For {assignment}, either assignment-id or - can be provided. If '-'
is provided, the response will include OSPolicyAssignmentReports for all
OSPolicyAssignments in the project/location.
Either {instance} or {assignment} must be -.
For example:
projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports
returns all reports for the instance
projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports
returns all the reports for the given assignment across all instances.
projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports
returns all the reports for all assignments across all instances.
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The parent resource name.
For {project}, either project-number or project-id can be provided.
For {instance}, either instance-name, instance-id, or - can be
provided. If '-' is provided, the response will include
OSPolicyAssignmentReports for all instances in the project/location.
For {assignment}, either assignment-id or - can be provided. If '-'
is provided, the response will include OSPolicyAssignmentReports for all
OSPolicyAssignments in the project/location.
Either {instance} or {assignment} must be -.
For example:
projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports
returns all reports for the instance
projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports
returns all the reports for the given assignment across all instances.
projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports
returns all the reports for all assignments across all instances.
For {project}, either project-number or project-id can be provided.
For {instance}, either instance-name, instance-id, or - can be
provided. If '-' is provided, the response will include
OSPolicyAssignmentReports for all instances in the project/location.
For {assignment}, either assignment-id or - can be provided. If '-'
is provided, the response will include OSPolicyAssignmentReports for all
OSPolicyAssignments in the project/location.
Either {instance} or {assignment} must be -.
For example:
projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports
returns all reports for the instance
projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports
returns all the reports for the given assignment across all instances.
projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports
returns all the reports for all assignments across all instances.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud OS Config V1 API - Class Google::Cloud::OsConfig::V1::ListOSPolicyAssignmentReportsRequest (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-os_config-v1/latest/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-os_config-v1/1.3.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [1.2.1](/ruby/docs/reference/google-cloud-os_config-v1/1.2.1/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-os_config-v1/1.1.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-os_config-v1/1.0.1/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-os_config-v1/0.16.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.15.2](/ruby/docs/reference/google-cloud-os_config-v1/0.15.2/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-os_config-v1/0.14.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-os_config-v1/0.13.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-os_config-v1/0.12.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-os_config-v1/0.11.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-os_config-v1/0.10.0/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest)\n- [0.9.1](/ruby/docs/reference/google-cloud-os_config-v1/0.9.1/Google-Cloud-OsConfig-V1-ListOSPolicyAssignmentReportsRequest) \nReference documentation and code samples for the Cloud OS Config V1 API class Google::Cloud::OsConfig::V1::ListOSPolicyAssignmentReportsRequest.\n\nList the OS policy assignment reports for VM instances. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response. \n**Returns**\n\n- (::String) --- If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response.\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The maximum number of results to return.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The maximum number of results to return. \n**Returns**\n\n- (::Integer) --- The maximum number of results to return.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from. \n**Returns**\n\n- (::String) --- A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent resource name.\n\n Format:\n `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports`\n\n For `{project}`, either `project-number` or `project-id` can be provided.\n For `{instance}`, either `instance-name`, `instance-id`, or `-` can be\n provided. If '-' is provided, the response will include\n OSPolicyAssignmentReports for all instances in the project/location.\n For `{assignment}`, either `assignment-id` or `-` can be provided. If '-'\n is provided, the response will include OSPolicyAssignmentReports for all\n OSPolicyAssignments in the project/location.\n Either {instance} or {assignment} must be `-`.\n\n For example:\n `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports`\n returns all reports for the instance\n `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports`\n returns all the reports for the given assignment across all instances.\n `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports`\n returns all the reports for all assignments across all instances.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent resource name.\n\n\n Format:\n `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports`\n\n For `{project}`, either `project-number` or `project-id` can be provided.\n For `{instance}`, either `instance-name`, `instance-id`, or `-` can be\n provided. If '-' is provided, the response will include\n OSPolicyAssignmentReports for all instances in the project/location.\n For `{assignment}`, either `assignment-id` or `-` can be provided. If '-'\n is provided, the response will include OSPolicyAssignmentReports for all\n OSPolicyAssignments in the project/location.\n Either {instance} or {assignment} must be `-`.\n\n For example:\n `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports`\n returns all reports for the instance\n `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports`\n returns all the reports for the given assignment across all instances.\n `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports`\nreturns all the reports for all assignments across all instances. \n**Returns**\n\n- (::String) --- Required. The parent resource name.\n\n Format:\n `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports`\n\n For `{project}`, either `project-number` or `project-id` can be provided.\n For `{instance}`, either `instance-name`, `instance-id`, or `-` can be\n provided. If '-' is provided, the response will include\n OSPolicyAssignmentReports for all instances in the project/location.\n For `{assignment}`, either `assignment-id` or `-` can be provided. If '-'\n is provided, the response will include OSPolicyAssignmentReports for all\n OSPolicyAssignments in the project/location.\n Either {instance} or {assignment} must be `-`.\n\n For example:\n `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports`\n returns all reports for the instance\n `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports`\n returns all the reports for the given assignment across all instances.\n `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports`\n returns all the reports for all assignments across all instances."]]