Class Inventory (2.30.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

Implements

InventoryOrBuilder

Static Fields

ITEMS_FIELD_NUMBER

public static final int ITEMS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OS_INFO_FIELD_NUMBER

public static final int OS_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Inventory getDefaultInstance()
Returns
TypeDescription
Inventory

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Inventory.Builder newBuilder()
Returns
TypeDescription
Inventory.Builder

newBuilder(Inventory prototype)

public static Inventory.Builder newBuilder(Inventory prototype)
Parameter
NameDescription
prototypeInventory
Returns
TypeDescription
Inventory.Builder

parseDelimitedFrom(InputStream input)

public static Inventory parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Inventory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Inventory parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Inventory parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Inventory parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Inventory parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Inventory parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Inventory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Inventory
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Inventory> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Inventory getDefaultInstanceForType()
Returns
TypeDescription
Inventory

getItems()

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

Use #getItemsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueInventory.Item
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Inventory.OsInfoOrBuilder

getParserForType()

public Parser<Inventory> getParserForType()
Returns
TypeDescription
Parser<Inventory>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

hasOsInfo()

public boolean hasOsInfo()

Base level operating system information for the VM.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Inventory.Builder newBuilderForType()
Returns
TypeDescription
Inventory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Inventory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Inventory.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Inventory.Builder toBuilder()
Returns
TypeDescription
Inventory.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException