Class InventoryItem
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.InventoryItem
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InventoryItem.Builder,InventoryItem>
@Generated("software.amazon.awssdk:codegen") public final class InventoryItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InventoryItem.Builder,InventoryItem>
Information collected from managed nodes based on your inventory policy document
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InventoryItem.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InventoryItem.Builder
builder()
String
captureTime()
The time the inventory information was collected.List<Map<String,String>>
content()
The inventory data of the inventory type.String
contentHash()
MD5 hash of the inventory item type contents.Map<String,String>
context()
A map of associated properties for a specified inventory type.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasContent()
For responses, this returns true if the service returned a value for the Content property.boolean
hasContext()
For responses, this returns true if the service returned a value for the Context property.int
hashCode()
String
schemaVersion()
The schema version for the inventory item.List<SdkField<?>>
sdkFields()
static Class<? extends InventoryItem.Builder>
serializableBuilderClass()
InventoryItem.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
typeName()
The name of the inventory type.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
typeName
public final String typeName()
The name of the inventory type. Default inventory item type names start with
AWS
. Custom inventory type names will start with Custom. Default inventory item types include the following:AWS:AWSComponent
,AWS:Application
,AWS:InstanceInformation
,AWS:Network
, andAWS:WindowsUpdate
.- Returns:
- The name of the inventory type. Default inventory item type names start with
AWS
. Custom inventory type names will start with Custom. Default inventory item types include the following:AWS:AWSComponent
,AWS:Application
,AWS:InstanceInformation
,AWS:Network
, andAWS:WindowsUpdate
.
-
schemaVersion
public final String schemaVersion()
The schema version for the inventory item.
- Returns:
- The schema version for the inventory item.
-
captureTime
public final String captureTime()
The time the inventory information was collected.
- Returns:
- The time the inventory information was collected.
-
contentHash
public final String contentHash()
MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.
- Returns:
- MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.
-
hasContent
public final boolean hasContent()
For responses, this returns true if the service returned a value for the Content property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
content
public final List<Map<String,String>> content()
The inventory data of the inventory type.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasContent()
method.- Returns:
- The inventory data of the inventory type.
-
hasContext
public final boolean hasContext()
For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
context
public final Map<String,String> context()
A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the
ExecutionId
,ExecutionType
,ComplianceType
properties of theAWS:ComplianceItem
type.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasContext()
method.- Returns:
- A map of associated properties for a specified inventory type. For example, with this attribute, you can
specify the
ExecutionId
,ExecutionType
,ComplianceType
properties of theAWS:ComplianceItem
type.
-
toBuilder
public InventoryItem.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InventoryItem.Builder,InventoryItem>
-
builder
public static InventoryItem.Builder builder()
-
serializableBuilderClass
public static Class<? extends InventoryItem.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-