Reference documentation and code samples for the Google Cloud OsConfig V1 Client class ListInventoriesRequest.
A request message for listing inventory data for all VMs in the specified
location.
Generated from protobuf messagegoogle.cloud.osconfig.v1.ListInventoriesRequest
Namespace
Google \ Cloud \ OsConfig \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent resource name. Format:projects/{project}/locations/{location}/instances/-For{project}, eitherproject-numberorproject-idcan be provided.
↳ view
int
Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
↳ page_size
int
The maximum number of results to return.
↳ page_token
string
A pagination token returned from a previous call toListInventoriesthat indicates where this listing should continue from.
↳ filter
string
If provided, this field specifies the criteria that must be met by aInventoryAPI resource to be included in the response.
getParent
Required. The parent resource name.
Format:projects/{project}/locations/{location}/instances/-For{project}, eitherproject-numberorproject-idcan be provided.
Returns
Type
Description
string
setParent
Required. The parent resource name.
Format:projects/{project}/locations/{location}/instances/-For{project}, eitherproject-numberorproject-idcan be provided.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getView
Inventory view indicating what information should be included in the
inventory resource. If unspecified, the default view is BASIC.
Returns
Type
Description
int
Enum of typeInventoryView.
setView
Inventory view indicating what information should be included in the
inventory resource. If unspecified, the default view is BASIC.
Parameter
Name
Description
var
int
Enum of typeInventoryView.
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
getPageToken
A pagination token returned from a previous call toListInventoriesthat indicates where this listing
should continue from.
Returns
Type
Description
string
setPageToken
A pagination token returned from a previous call toListInventoriesthat indicates where this listing
should continue from.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
If provided, this field specifies the criteria that must be met by aInventoryAPI resource to be included in the response.
Returns
Type
Description
string
setFilter
If provided, this field specifies the criteria that must be met by aInventoryAPI resource to be included in the response.
[[["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,["# Google Cloud OsConfig V1 Client - Class ListInventoriesRequest (2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/php/docs/reference/cloud-osconfig/latest/V1.ListInventoriesRequest)\n- [2.0.5](/php/docs/reference/cloud-osconfig/2.0.5/V1.ListInventoriesRequest)\n- [1.3.5](/php/docs/reference/cloud-osconfig/1.3.5/V1.ListInventoriesRequest)\n- [1.2.2](/php/docs/reference/cloud-osconfig/1.2.2/V1.ListInventoriesRequest)\n- [1.1.1](/php/docs/reference/cloud-osconfig/1.1.1/V1.ListInventoriesRequest)\n- [1.0.5](/php/docs/reference/cloud-osconfig/1.0.5/V1.ListInventoriesRequest) \nReference documentation and code samples for the Google Cloud OsConfig V1 Client class ListInventoriesRequest.\n\nA request message for listing inventory data for all VMs in the specified\nlocation.\n\nGenerated from protobuf message `google.cloud.osconfig.v1.ListInventoriesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ OsConfig \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent resource name.\n\nFormat: `projects/{project}/locations/{location}/instances/-`\nFor `{project}`, either `project-number` or `project-id` can be provided.\n\n### setParent\n\nRequired. The parent resource name.\n\nFormat: `projects/{project}/locations/{location}/instances/-`\nFor `{project}`, either `project-number` or `project-id` can be provided.\n\n### getView\n\nInventory view indicating what information should be included in the\ninventory resource. If unspecified, the default view is BASIC.\n\n### setView\n\nInventory view indicating what information should be included in the\ninventory resource. If unspecified, the default view is BASIC.\n\n### getPageSize\n\nThe maximum number of results to return.\n\n### setPageSize\n\nThe maximum number of results to return.\n\n### getPageToken\n\nA pagination token returned from a previous call to\n`ListInventories` that indicates where this listing\nshould continue from.\n\n### setPageToken\n\nA pagination token returned from a previous call to\n`ListInventories` that indicates where this listing\nshould continue from.\n\n### getFilter\n\nIf provided, this field specifies the criteria that must be met by a\n`Inventory` API resource to be included in the response.\n\n### setFilter\n\nIf provided, this field specifies the criteria that must be met by a\n`Inventory` API resource to be included in the response.\n\n### static::build"]]
