Google Cloud OsConfig V1 Client - Class ListInventoriesRequest (1.3.4)

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 message google.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}, either project-number or project-id can 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 to ListInventories that indicates where this listing should continue from.

↳ filter string

If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.

getParent

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can be provided.

Returns
Type Description
string

setParent

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can 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

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
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 to ListInventories that indicates where this listing should continue from.

Returns
Type Description
string

setPageToken

A pagination token returned from a previous call to ListInventories that 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 a Inventory API resource to be included in the response.

Returns
Type Description
string

setFilter

If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/-

For {project}, either project-number or project-id can be provided. Please see Google\Cloud\OsConfig\V1\OsConfigZonalServiceClient::instanceName() for help formatting this field.

Returns
Type Description
Google\Cloud\OsConfig\V1\ListInventoriesRequest