Class FlowNode

    • Method Detail

      • configuration

        public final FlowNodeConfiguration configuration()

        Contains configurations for the node.

        Returns:
        Contains configurations for the node.
      • hasInputs

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

        public final List<FlowNodeInput> inputs()

        An array of objects, each of which contains information about an input into the node.

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

        Returns:
        An array of objects, each of which contains information about an input into the node.
      • name

        public final String name()

        A name for the node.

        Returns:
        A name for the node.
      • hasOutputs

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

        public final List<FlowNodeOutput> outputs()

        A list of objects, each of which contains information about an output from the node.

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

        Returns:
        A list of objects, each of which contains information about an output from the node.
      • type

        public final FlowNodeType type()

        The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

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

        Returns:
        The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
        See Also:
        FlowNodeType
      • typeAsString

        public final String typeAsString()

        The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.

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

        Returns:
        The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
        See Also:
        FlowNodeType
      • 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)