Class GetConnectionsFilter

    • Method Detail

      • hasMatchCriteria

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

        public final List<String> matchCriteria()

        A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.

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

        Returns:
        A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
      • connectionType

        public final ConnectionType connectionType()

        The type of connections to return. Currently, SFTP is not supported.

        If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

        Returns:
        The type of connections to return. Currently, SFTP is not supported.
        See Also:
        ConnectionType
      • connectionTypeAsString

        public final String connectionTypeAsString()

        The type of connections to return. Currently, SFTP is not supported.

        If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

        Returns:
        The type of connections to return. Currently, SFTP is not supported.
        See Also:
        ConnectionType
      • 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)