Class RequestMetadataFilters

    • Method Detail

      • hasEqualsValue

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

        public final Map<String,​String> equalsValue()

        Include results where the key equals the value.

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

        Returns:
        Include results where the key equals the value.
      • hasNotEquals

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

        public final Map<String,​String> notEquals()

        Include results where the key does not equal the value.

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

        Returns:
        Include results where the key does not equal the value.
      • hasAndAll

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

        public final List<RequestMetadataBaseFilters> andAll()

        Include results where all of the based filters match.

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

        Returns:
        Include results where all of the based filters match.
      • hasOrAll

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

        public final List<RequestMetadataBaseFilters> orAll()

        Include results where any of the base filters match.

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

        Returns:
        Include results where any of the base filters match.
      • 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)
      • fromEqualsValue

        public static RequestMetadataFilters fromEqualsValue​(Map<String,​String> equalsValue)
        Create an instance of this class with equalsValue() initialized to the given value.

        Include results where the key equals the value.

        Parameters:
        equalsValue - Include results where the key equals the value.
      • fromNotEquals

        public static RequestMetadataFilters fromNotEquals​(Map<String,​String> notEquals)
        Create an instance of this class with notEquals() initialized to the given value.

        Include results where the key does not equal the value.

        Parameters:
        notEquals - Include results where the key does not equal the value.
      • fromAndAll

        public static RequestMetadataFilters fromAndAll​(List<RequestMetadataBaseFilters> andAll)
        Create an instance of this class with andAll() initialized to the given value.

        Include results where all of the based filters match.

        Parameters:
        andAll - Include results where all of the based filters match.
      • fromOrAll

        public static RequestMetadataFilters fromOrAll​(List<RequestMetadataBaseFilters> orAll)
        Create an instance of this class with orAll() initialized to the given value.

        Include results where any of the base filters match.

        Parameters:
        orAll - Include results where any of the base filters match.