Class StepInput

    • Method Detail

      • integerValue

        public final Integer integerValue()

        The value of the integer.

        Returns:
        The value of the integer.
      • stringValue

        public final String stringValue()

        String value.

        Returns:
        String value.
      • hasListOfStringsValue

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

        public final List<String> listOfStringsValue()

        List of string values.

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

        Returns:
        List of string values.
      • hasMapOfStringValue

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

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

        Map of string values.

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

        Returns:
        Map of string values.
      • 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)
      • fromIntegerValue

        public static StepInput fromIntegerValue​(Integer integerValue)
        Create an instance of this class with integerValue() initialized to the given value.

        The value of the integer.

        Parameters:
        integerValue - The value of the integer.
      • fromStringValue

        public static StepInput fromStringValue​(String stringValue)
        Create an instance of this class with stringValue() initialized to the given value.

        String value.

        Parameters:
        stringValue - String value.
      • fromListOfStringsValue

        public static StepInput fromListOfStringsValue​(List<String> listOfStringsValue)
        Create an instance of this class with listOfStringsValue() initialized to the given value.

        List of string values.

        Parameters:
        listOfStringsValue - List of string values.
      • fromMapOfStringValue

        public static StepInput fromMapOfStringValue​(Map<String,​String> mapOfStringValue)
        Create an instance of this class with mapOfStringValue() initialized to the given value.

        Map of string values.

        Parameters:
        mapOfStringValue - Map of string values.
      • type

        public StepInput.Type type()
        Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be StepInput.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be StepInput.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.