Class TransformConfigParameter

    • Method Detail

      • name

        public final String name()

        Specifies the name of the parameter in the config file of the dynamic transform.

        Returns:
        Specifies the name of the parameter in the config file of the dynamic transform.
      • type

        public final ParamType type()

        Specifies the parameter type in the config file of the dynamic transform.

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

        Returns:
        Specifies the parameter type in the config file of the dynamic transform.
        See Also:
        ParamType
      • typeAsString

        public final String typeAsString()

        Specifies the parameter type in the config file of the dynamic transform.

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

        Returns:
        Specifies the parameter type in the config file of the dynamic transform.
        See Also:
        ParamType
      • validationRule

        public final String validationRule()

        Specifies the validation rule in the config file of the dynamic transform.

        Returns:
        Specifies the validation rule in the config file of the dynamic transform.
      • validationMessage

        public final String validationMessage()

        Specifies the validation message in the config file of the dynamic transform.

        Returns:
        Specifies the validation message in the config file of the dynamic transform.
      • hasValue

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

        public final List<String> value()

        Specifies the value of the parameter in the config file of the dynamic transform.

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

        Returns:
        Specifies the value of the parameter in the config file of the dynamic transform.
      • listType

        public final ParamType listType()

        Specifies the list type of the parameter in the config file of the dynamic transform.

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

        Returns:
        Specifies the list type of the parameter in the config file of the dynamic transform.
        See Also:
        ParamType
      • listTypeAsString

        public final String listTypeAsString()

        Specifies the list type of the parameter in the config file of the dynamic transform.

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

        Returns:
        Specifies the list type of the parameter in the config file of the dynamic transform.
        See Also:
        ParamType
      • isOptional

        public final Boolean isOptional()

        Specifies whether the parameter is optional or not in the config file of the dynamic transform.

        Returns:
        Specifies whether the parameter is optional or not in the config file of the dynamic transform.
      • 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)