Annotation Type SendGridOutput


  • @Retention(RUNTIME)
    @Target({PARAMETER,METHOD})
    public @interface SendGridOutput

    Place this on a parameter whose value would be written to SendGrid. The parameter type should be OutputBinding<T>, where T could be one of:

    • Any native Java types such as int, String, byte[]
    • Any POJO type
    Since:
    1.0.0
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String apiKey
      Defines the API key of the SendGrid to which to write.
      java.lang.String from
      Defines the 'FROM' name of the SendGrid to which to write.
      java.lang.String name
      The variable name used in function.json.
      java.lang.String subject
      Defines the subject of the SendGrid email to which to write.
      java.lang.String text
      Defines the content text of the SendGrid email to which to write.
      java.lang.String to
      Defines the 'TO' email of the SendGrid to which to write.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String dataType
      Defines how Functions runtime should treat the parameter value.
    • Element Detail

      • name

        java.lang.String name
        The variable name used in function.json.
        Returns:
        The variable name used in function.json.
      • apiKey

        java.lang.String apiKey
        Defines the API key of the SendGrid to which to write.
        Returns:
        The SendGrid API key string.
      • to

        java.lang.String to
        Defines the 'TO' email of the SendGrid to which to write.
        Returns:
        The SendGrid 'TO' email string.
      • from

        java.lang.String from
        Defines the 'FROM' name of the SendGrid to which to write.
        Returns:
        The SendGrid 'FROM' name string.
      • subject

        java.lang.String subject
        Defines the subject of the SendGrid email to which to write.
        Returns:
        The SendGrid email subject string.
      • text

        java.lang.String text
        Defines the content text of the SendGrid email to which to write.
        Returns:
        The SendGrid email content string.
      • dataType

        java.lang.String dataType

        Defines how Functions runtime should treat the parameter value. Possible values are:

        • "" or string: treat it as a string whose value is serialized from the parameter
        • binary: treat it as a binary data whose value comes from for example OutputBinding<byte[]>
        Returns:
        The dataType which will be used by the Functions runtime.
        Default:
        ""