Class InputAttachment

    • Method Detail

      • automaticInputFailoverSettings

        public final AutomaticInputFailoverSettings automaticInputFailoverSettings()
        User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.
        Returns:
        User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.
      • inputAttachmentName

        public final String inputAttachmentName()
        User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
        Returns:
        User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
      • inputId

        public final String inputId()
        The ID of the input
        Returns:
        The ID of the input
      • inputSettings

        public final InputSettings inputSettings()
        Settings of an input (caption selector, etc.)
        Returns:
        Settings of an input (caption selector, etc.)
      • hasLogicalInterfaceNames

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

        public final List<String> logicalInterfaceNames()
        Optional assignment of an input to a logical interface on the Node. Only applies to on premises channels.

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

        Returns:
        Optional assignment of an input to a logical interface on the Node. Only applies to on premises channels.
      • 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)