Class Inventory (2.47.0) 

public final class Inventory extends GeneratedMessageV3 implements InventoryOrBuilder

This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time.

You can use this API resource to determine the inventory data of your VM.

For more information, see Information provided by OS inventory management.

Protobuf type google.cloud.osconfig.v1.Inventory

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Inventory

Implements

InventoryOrBuilder

Static Fields

ITEMS_FIELD_NUMBER

public static final int ITEMS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OS_INFO_FIELD_NUMBER

public static final int OS_INFO_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Inventory getDefaultInstance()
Returns
Type Description
Inventory

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Inventory.Builder newBuilder()
Returns
Type Description
Inventory.Builder

newBuilder(Inventory prototype)

public static Inventory.Builder newBuilder(Inventory prototype)
Parameter
Name Description
prototype Inventory
Returns
Type Description
Inventory.Builder

parseDelimitedFrom(InputStream input)

public static Inventory parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Inventory
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Inventory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Inventory
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Inventory parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Inventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Inventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Inventory parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Inventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Inventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Inventory parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Inventory
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Inventory
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Inventory parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Inventory
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Inventory
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Inventory parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Inventory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Inventory
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Inventory> parser()
Returns
Type Description
Parser<Inventory>

Methods

containsItems(String key)

public boolean containsItems(String key)

Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.

map<string, .google.cloud.osconfig.v1.Inventory.Item> items = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Inventory getDefaultInstanceForType()
Returns
Type Description
Inventory

getItems() (deprecated)

public Map<String,Inventory.Item> getItems()

Use #getItemsMap() instead.

Returns
Type Description
Map<String,Item>

getItemsCount()

public int getItemsCount()

Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.

map<string, .google.cloud.osconfig.v1.Inventory.Item> items = 2;

Returns
Type Description
int

getItemsMap()

public Map<String,Inventory.Item> getItemsMap()

Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.

map<string, .google.cloud.osconfig.v1.Inventory.Item> items = 2;

Returns
Type Description
Map<String,Item>

getItemsOrDefault(String key, Inventory.Item defaultValue)

public Inventory.Item getItemsOrDefault(String key, Inventory.Item defaultValue)

Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.

map<string, .google.cloud.osconfig.v1.Inventory.Item> items = 2;

Parameters
Name Description
key String
defaultValue Inventory.Item
Returns
Type Description
Inventory.Item

getItemsOrThrow(String key)

public Inventory.Item getItemsOrThrow(String key)

Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.

map<string, .google.cloud.osconfig.v1.Inventory.Item> items = 2;

Parameter
Name Description
key String
Returns
Type Description
Inventory.Item

getName()

public String getName()

Output only. The Inventory API resource name.

Format: projects/{project_number}/locations/{location}/instances/{instance_id}/inventory

string name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The Inventory API resource name.

Format: projects/{project_number}/locations/{location}/instances/{instance_id}/inventory

string name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getOsInfo()

public Inventory.OsInfo getOsInfo()

Base level operating system information for the VM.

.google.cloud.osconfig.v1.Inventory.OsInfo os_info = 1;

Returns
Type Description
Inventory.OsInfo

The osInfo.

getOsInfoOrBuilder()

public Inventory.OsInfoOrBuilder getOsInfoOrBuilder()

Base level operating system information for the VM.

.google.cloud.osconfig.v1.Inventory.OsInfo os_info = 1;

Returns
Type Description
Inventory.OsInfoOrBuilder

getParserForType()

public Parser<Inventory> getParserForType()
Returns
Type Description
Parser<Inventory>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp of the last reported inventory for the VM.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp of the last reported inventory for the VM.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasOsInfo()

public boolean hasOsInfo()

Base level operating system information for the VM.

.google.cloud.osconfig.v1.Inventory.OsInfo os_info = 1;

Returns
Type Description
boolean

Whether the osInfo field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp of the last reported inventory for the VM.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Inventory.Builder newBuilderForType()
Returns
Type Description
Inventory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Inventory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Inventory.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Inventory.Builder toBuilder()
Returns
Type Description
Inventory.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException