Skip to content

[Doc]--Set partition key for message when using function publish #7431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sijie merged 1 commit into from
Jul 6, 2020
Merged

[Doc]--Set partition key for message when using function publish #7431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions site2/website/versioned_docs/version-2.4.0/functions-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ Both the [Java](#java-sdk-functions) and [Python](#python-sdk-functions) SDKs pr

* The name and ID of the Pulsar Function
* The message ID of each message. Each Pulsar message is automatically assigned an ID.
* The key, event time, properties and partition key of each message
* The name of the topic on which the message was sent
* The names of all input topics as well as the output topic associated with the function
* The name of the class used for [SerDe](#serialization-and-deserialization-serde)
Expand All @@ -120,6 +121,8 @@ Both the [Java](#java-sdk-functions) and [Python](#python-sdk-functions) SDKs pr
* Access to arbitrary [user config](#user-config) values supplied via the CLI
* An interface for recording [metrics](functions-metrics.md)
* An interface for storing and retrieving state in [state storage](functions-overview.md#state-storage)
* A function to publish new messages onto arbitrary topics.
* A function to acknowledge the message being processed (if auto-acknowledgement is disabled).

### User config

Expand Down Expand Up @@ -573,6 +576,9 @@ The [`Context`](https://github.com/apache/pulsar/blob/master/pulsar-client-cpp/p
Method | What it provides
:------|:----------------
`get_message_id` | The message ID of the message being processed
`get_message_key` | The key of the message being processed
`get_message_eventtime` | The event time of the message being processed
`get_message_properties` | The properties of the message being processed
`get_current_message_topic_name` | The topic of the message being currently being processed
`get_function_tenant` | The tenant under which the current Pulsar Function runs under
`get_function_namespace` | The namespace under which the current Pulsar Function runs under
Expand All @@ -583,10 +589,17 @@ Method | What it provides
`get_logger` | A logger object that can be used for [logging](#python-logging)
`get_user_config_value` | Returns the value of a [user-defined config](#python-user-config) (or `None` if the config doesn't exist)
`get_user_config_map` | Returns the entire user-defined config as a dict
`get_secret` | The secret value associated with the name
`get_partition_key` | The partition key of the input message
`record_metric` | Records a per-key [metric](#python-metrics)
`publish` | Publishes a message to the specified Pulsar topic
`get_output_serde_class_name` | The name of the output [SerDe](#python-serde) class
`ack` | [Acks](reference-terminology.md#acknowledgment-ack) the message being processed to Pulsar
`incr_counter` | Increase the counter of a given key in the managed state
`get_counter` | Get the counter of a given key in the managed state
`del_counter` | Delete the counter of a given key in the managed state
`put_state` | Update the value of a given key in the managed state
`get_state` | Get the value of a given key in the managed state

### Python SerDe

Expand Down