Class AgentHierarchyGroups

java.lang.Object
software.amazon.awssdk.services.connect.model.AgentHierarchyGroups
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentHierarchyGroups.Builder,AgentHierarchyGroups>

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

A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

See Also:
  • Method Details

    • hasL1Ids

      public final boolean hasL1Ids()
      For responses, this returns true if the service returned a value for the L1Ids 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.
    • l1Ids

      public final List<String> l1Ids()

      The identifiers for level 1 hierarchy groups.

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

      Returns:
      The identifiers for level 1 hierarchy groups.
    • hasL2Ids

      public final boolean hasL2Ids()
      For responses, this returns true if the service returned a value for the L2Ids 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.
    • l2Ids

      public final List<String> l2Ids()

      The identifiers for level 2 hierarchy groups.

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

      Returns:
      The identifiers for level 2 hierarchy groups.
    • hasL3Ids

      public final boolean hasL3Ids()
      For responses, this returns true if the service returned a value for the L3Ids 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.
    • l3Ids

      public final List<String> l3Ids()

      The identifiers for level 3 hierarchy groups.

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

      Returns:
      The identifiers for level 3 hierarchy groups.
    • hasL4Ids

      public final boolean hasL4Ids()
      For responses, this returns true if the service returned a value for the L4Ids 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.
    • l4Ids

      public final List<String> l4Ids()

      The identifiers for level 4 hierarchy groups.

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

      Returns:
      The identifiers for level 4 hierarchy groups.
    • hasL5Ids

      public final boolean hasL5Ids()
      For responses, this returns true if the service returned a value for the L5Ids 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.
    • l5Ids

      public final List<String> l5Ids()

      The identifiers for level 5 hierarchy groups.

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

      Returns:
      The identifiers for level 5 hierarchy groups.
    • toBuilder

      public AgentHierarchyGroups.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<AgentHierarchyGroups.Builder,AgentHierarchyGroups>
      Returns:
      a builder for type T
    • builder

      public static AgentHierarchyGroups.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AgentHierarchyGroups.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.