Class FunctionResponse

    • Method Detail

      • hasRequiredProperties

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

        public final List<String> requiredProperties()

        The required properties of the function.

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

        Returns:
        The required properties of the function.
      • scope

        public final Scope scope()

        The scope of the function.

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

        Returns:
        The scope of the function.
        See Also:
        Scope
      • scopeAsString

        public final String scopeAsString()

        The scope of the function.

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

        Returns:
        The scope of the function.
        See Also:
        Scope
      • implementedBy

        public final DataConnector implementedBy()

        The data connector.

        Returns:
        The data connector.
      • isInherited

        public final Boolean isInherited()

        Indicates whether this function is inherited.

        Returns:
        Indicates whether this function is inherited.
      • 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)