Package software.amazon.awssdk.services.ssm.model

Class InventoryItemSchema

java.lang.Object

software.amazon.awssdk.services.ssm.model.InventoryItemSchema

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InventoryItemSchema.Builder,InventoryItemSchema>

@Generated("software.amazon.awssdk:codegen")
public final class InventoryItemSchema
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InventoryItemSchema.Builder,InventoryItemSchema>

The inventory item schema definition. Users can use this to compose inventory query filters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InventoryItemSchema.Builder

Method Summary

Modifier and Type	Method	Description
List<InventoryItemAttribute>	attributes()	The schema attributes for inventory.
static InventoryItemSchema.Builder	builder()
String	displayName()	The alias name of the inventory type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InventoryItemSchema.Builder>	serializableBuilderClass()
InventoryItemSchema.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	typeName()	The name of the inventory type.
String	version()	The schema version for the inventory item.

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 Amazon Web Services. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

Returns:

The name of the inventory type. Default inventory item type names start with Amazon Web Services. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

version

public final String version()

The schema version for the inventory item.

Returns:

The schema version for the inventory item.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

attributes

public final List<InventoryItemAttribute> attributes()

The schema attributes for inventory. This contains data type and attribute name.

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 hasAttributes() method.

Returns:

The schema attributes for inventory. This contains data type and attribute name.

displayName

public final String displayName()

The alias name of the inventory type. The alias name is used for display purposes.

Returns:

The alias name of the inventory type. The alias name is used for display purposes.

toBuilder

public InventoryItemSchema.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InventoryItemSchema.Builder,InventoryItemSchema>

builder

public static InventoryItemSchema.Builder builder()

serializableBuilderClass

public static Class<? extends InventoryItemSchema.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo