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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InventoryItemSchema.Builder,InventoryItemSchema>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.