Github user mjsax commented on a diff in the pull request:
https://github.com/apache/flink/pull/1813#discussion_r67622515
--- Diff:
flink-streaming-connectors/flink-connector-redis/src/main/java/org/apache/flink/streaming/connectors/redis/common/mapper/RedisDataTypeDescription.java
---
@@ -0,0 +1,90 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.flink.streaming.connectors.redis.common.mapper;
+
+import java.io.Serializable;
+
+/**
+ * The description of the data type. This must be passed while creating
new {@link RedisMapper}.
+ * <p>When creating descriptor for {@link RedisDataType#HASH} and {@link
RedisDataType#SORTED_SET},
+ * plz use the first constructor {@link
#RedisDataTypeDescription(RedisDataType, String)}.
+ * If the additional key is null it will throw IllegalArgumentException
+ *
+ * <p>When {@link RedisDataType} is not {@link RedisDataType#HASH} and
{@link RedisDataType#SORTED_SET}
+ * plz use the second constructor {@link
#RedisDataTypeDescription(RedisDataType)}
+ */
+public class RedisDataTypeDescription implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private RedisDataType dataType;
+
+ /**
+ * This additional key needed for {@link RedisDataType#HASH} and {@link
RedisDataType#SORTED_SET}.
+ * Other {@link RedisDataType} works only with two variable i.e. name
of the list and value to be added.
+ * But for {@link RedisDataType#HASH} and {@link
RedisDataType#SORTED_SET} we need three variables.
+ * <p>For {@link RedisDataType#HASH} we need hash name, hash key and
element.
+ * {@link #getAdditionalKey()} used as hash name for {@link
RedisDataType#HASH}
+ * <p>For {@link RedisDataType#SORTED_SET} we need set name, the
element and it's score.
+ * {@link #getAdditionalKey()} used as set name for {@link
RedisDataType#SORTED_SET}
+ */
+ private String additionalKey;
+
+ /**
+ * Use this constructor when data type is HASH or SORTED_SET.
+ *
--- End diff --
If different data type is specified, {@code additionalKey} is ignored.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
