Reference documentation and code samples for the Google Cloud OsConfig V1 Client class ListOSPolicyAssignmentReportsRequest.
List the OS policy assignment reports for VM instances.
Generated from protobuf message google.cloud.osconfig.v1.ListOSPolicyAssignmentReportsRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource name. Format: |
↳ page_size |
int
The maximum number of results to return. |
↳ filter |
string
If provided, this field specifies the criteria that must be met by the |
↳ page_token |
string
A pagination token returned from a previous call to the |
getParent
Required. The parent resource name.
Format:
projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports
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.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The parent resource name.
Format:
projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
The maximum number of results to return.
Returns | |
---|---|
Type | Description |
int |
setPageSize
The maximum number of results to return.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
If provided, this field specifies the criteria that must be met by the
OSPolicyAssignmentReport
API resource that is included in the response.
Returns | |
---|---|
Type | Description |
string |
setFilter
If provided, this field specifies the criteria that must be met by the
OSPolicyAssignmentReport
API resource that is included in the response.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
A pagination token returned from a previous call to the
ListOSPolicyAssignmentReports
method that indicates where this listing
should continue from.
Returns | |
---|---|
Type | Description |
string |
setPageToken
A pagination token returned from a previous call to the
ListOSPolicyAssignmentReports
method that indicates where this listing
should continue from.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |