Class TagFilter

    • Method Detail

      • hasAndConditions

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

        public final List<TagCondition> andConditions()

        A list of conditions which would be applied together with an AND condition.

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

        Returns:
        A list of conditions which would be applied together with an AND condition.
      • hasOrConditions

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

        public final List<OrCondition> orConditions()

        A list of conditions which would be applied together with an OR condition.

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

        Returns:
        A list of conditions which would be applied together with an OR condition.
      • tagCondition

        public final TagCondition tagCondition()

        A leaf node condition which can be used to specify a tag condition.

        Returns:
        A leaf node condition which can be used to specify a tag condition.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)
      • fromAndConditions

        public static TagFilter fromAndConditions​(List<TagCondition> andConditions)
        Create an instance of this class with andConditions() initialized to the given value.

        A list of conditions which would be applied together with an AND condition.

        Parameters:
        andConditions - A list of conditions which would be applied together with an AND condition.
      • fromOrConditions

        public static TagFilter fromOrConditions​(List<OrCondition> orConditions)
        Create an instance of this class with orConditions() initialized to the given value.

        A list of conditions which would be applied together with an OR condition.

        Parameters:
        orConditions - A list of conditions which would be applied together with an OR condition.
      • fromTagCondition

        public static TagFilter fromTagCondition​(TagCondition tagCondition)
        Create an instance of this class with tagCondition() initialized to the given value.

        A leaf node condition which can be used to specify a tag condition.

        Parameters:
        tagCondition - A leaf node condition which can be used to specify a tag condition.
      • fromTagCondition

        public static TagFilter fromTagCondition​(Consumer<TagCondition.Builder> tagCondition)
        Create an instance of this class with tagCondition() initialized to the given value.

        A leaf node condition which can be used to specify a tag condition.

        Parameters:
        tagCondition - A leaf node condition which can be used to specify a tag condition.
      • type

        public TagFilter.Type type()
        Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be TagFilter.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be TagFilter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.