[
https://issues.apache.org/jira/browse/FLINK-1422?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14307361#comment-14307361
]
ASF GitHub Bot commented on FLINK-1422:
---------------------------------------
Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/350#discussion_r24168441
--- Diff: docs/programming_guide.md ---
@@ -2398,6 +2399,61 @@ of a function, or use the `withParameters(...)`
method to pass in a configuratio
[Back to top](#top)
+Passing parameters to functions
+-------------------
+
+Parameters can be passed to rich functions using either the constructor
(if the function is
--- End diff --
If the function is not serialisable the program will fail in any case. That
is not related to the configuration.
IMO, the documentation should state that the function object is serialised
using standard java serialization and shipped "as-is" to all parallel task
instances. Mentioning that transient fields are not shipped is OK but not
mandatory (somebody who uses the transient keyword should know what it does).
> Missing usage example for "withParameters"
> ------------------------------------------
>
> Key: FLINK-1422
> URL: https://issues.apache.org/jira/browse/FLINK-1422
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 0.8
> Reporter: Alexander Alexandrov
> Assignee: Chesnay Schepler
> Priority: Trivial
> Fix For: 0.8.1
>
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> I am struggling to find a usage example of the "withParameters" method in the
> documentation. At the moment I only see this note:
> {quote}
> Note: As the content of broadcast variables is kept in-memory on each node,
> it should not become too large. For simpler things like scalar values you can
> simply make parameters part of the closure of a function, or use the
> withParameters(...) method to pass in a configuration.
> {quote}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
