Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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.kafka.streams.kstream;
import org.apache.kafka.common.serialization.Serde;
import java.time.Duration;
/**
* The {@code Joined} class represents optional params that can be passed to
* {@link KStream#join(KTable, ValueJoiner, Joined) KStream#join(KTable,...)} and
* {@link KStream#leftJoin(KTable, ValueJoiner) KStream#leftJoin(KTable,...)} operations.
*/
public class Joined implements NamedOperation> {
protected final Serde keySerde;
protected final Serde valueSerde;
protected final Serde otherValueSerde;
protected final String name;
protected final Duration gracePeriod;
private Joined(final Serde keySerde,
final Serde valueSerde,
final Serde otherValueSerde,
final String name,
final Duration gracePeriod) {
this.keySerde = keySerde;
this.valueSerde = valueSerde;
this.otherValueSerde = otherValueSerde;
this.name = name;
this.gracePeriod = gracePeriod;
}
protected Joined(final Joined joined) {
this(joined.keySerde, joined.valueSerde, joined.otherValueSerde, joined.name, joined.gracePeriod);
}
/**
* Create an instance of {@code Joined} with key, value, and otherValue {@link Serde} instances.
* {@code null} values are accepted and will be replaced by the default serdes as defined in config.
*
* @param keySerde the key serde to use. If {@code null} the default key serde from config will be used
* @param valueSerde the value serde to use. If {@code null} the default value serde from config will be used
* @param otherValueSerde the otherValue serde to use. If {@code null} the default value serde from config will be used
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance with the provided serdes
*/
public static Joined with(final Serde keySerde,
final Serde valueSerde,
final Serde otherValueSerde) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, null, null);
}
/**
* Create an instance of {@code Joined} with key, value, and otherValue {@link Serde} instances.
* {@code null} values are accepted and will be replaced by the default serdes as defined in
* config.
*
* @param keySerde the key serde to use. If {@code null} the default key serde from config will be
* used
* @param valueSerde the value serde to use. If {@code null} the default value serde from config
* will be used
* @param otherValueSerde the otherValue serde to use. If {@code null} the default value serde
* from config will be used
* @param name the name used as the base for naming components of the join including any
* repartition topics
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance with the provided serdes
*/
public static Joined with(final Serde keySerde,
final Serde valueSerde,
final Serde otherValueSerde,
final String name) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, null);
}
/**
* Create an instance of {@code Joined} with key, value, and otherValue {@link Serde} instances.
* {@code null} values are accepted and will be replaced by the default serdes as defined in
* config.
*
* @param keySerde the key serde to use. If {@code null} the default key serde from config will be
* used
* @param valueSerde the value serde to use. If {@code null} the default value serde from config
* will be used
* @param otherValueSerde the otherValue serde to use. If {@code null} the default value serde
* from config will be used
* @param name the name used as the base for naming components of the join including any
* repartition topics
* @param gracePeriod stream buffer time
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance with the provided serdes
*/
public static Joined with(final Serde keySerde,
final Serde valueSerde,
final Serde otherValueSerde,
final String name,
final Duration gracePeriod) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, gracePeriod);
}
/**
* Create an instance of {@code Joined} with a key {@link Serde}.
* {@code null} values are accepted and will be replaced by the default key serde as defined in config.
*
* @param keySerde the key serde to use. If {@code null} the default key serde from config will be used
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance configured with the keySerde
*/
public static Joined keySerde(final Serde keySerde) {
return new Joined<>(keySerde, null, null, null, null);
}
/**
* Create an instance of {@code Joined} with a value {@link Serde}.
* {@code null} values are accepted and will be replaced by the default value serde as defined in config.
*
* @param valueSerde the value serde to use. If {@code null} the default value serde from config will be used
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance configured with the valueSerde
*/
public static Joined valueSerde(final Serde valueSerde) {
return new Joined<>(null, valueSerde, null, null, null);
}
/**
* Create an instance of {@code Joined} with an other value {@link Serde}.
* {@code null} values are accepted and will be replaced by the default value serde as defined in config.
*
* @param otherValueSerde the otherValue serde to use. If {@code null} the default value serde from config will be used
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance configured with the otherValueSerde
*/
public static Joined otherValueSerde(final Serde otherValueSerde) {
return new Joined<>(null, null, otherValueSerde, null, null);
}
/**
* Create an instance of {@code Joined} with base name for all components of the join, this may
* include any repartition topics created to complete the join.
*
* @param name the name used as the base for naming components of the join including any
* repartition topics
* @param key type
* @param value type
* @param other value type
* @return new {@code Joined} instance configured with the name
*
*/
public static Joined as(final String name) {
return new Joined<>(null, null, null, name, null);
}
/**
* Set the key {@link Serde} to be used. Null values are accepted and will be replaced by the default
* key serde as defined in config
*
* @param keySerde the key serde to use. If null the default key serde from config will be used
* @return new {@code Joined} instance configured with the {@code name}
*/
public Joined withKeySerde(final Serde keySerde) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, gracePeriod);
}
/**
* Set the value {@link Serde} to be used. Null values are accepted and will be replaced by the default
* value serde as defined in config
*
* @param valueSerde the value serde to use. If null the default value serde from config will be used
* @return new {@code Joined} instance configured with the {@code valueSerde}
*/
public Joined withValueSerde(final Serde valueSerde) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, gracePeriod);
}
/**
* Set the otherValue {@link Serde} to be used. Null values are accepted and will be replaced by the default
* value serde as defined in config
*
* @param otherValueSerde the otherValue serde to use. If null the default value serde from config will be used
* @return new {@code Joined} instance configured with the {@code valueSerde}
*/
public Joined withOtherValueSerde(final Serde otherValueSerde) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, gracePeriod);
}
/**
* Set the base name used for all components of the join, this may include any repartition topics
* created to complete the join.
*
* @param name the name used as the base for naming components of the join including any
* repartition topics
* @return new {@code Joined} instance configured with the {@code name}
*/
@Override
public Joined withName(final String name) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, gracePeriod);
}
/**
* Set the grace period on the stream side of the join. Records will enter a buffer before being processed.
* Out of order records in the grace period will be processed in timestamp order. Late records, out of the
* grace period, will be executed right as they come in, if it is past the table history retention this could
* result in a null join. Long gaps in stream side arriving records will cause
* records to be delayed in processing.
*
*
* @param gracePeriod the duration of the grace period. Must be less than the joining table's history retention.
* @return new {@code Joined} instance configured with the gracePeriod
*/
public Joined withGracePeriod(final Duration gracePeriod) {
return new Joined<>(keySerde, valueSerde, otherValueSerde, name, gracePeriod);
}
public Duration gracePeriod() {
return gracePeriod;
}
public Serde keySerde() {
return keySerde;
}
public Serde valueSerde() {
return valueSerde;
}
public Serde otherValueSerde() {
return otherValueSerde;
}
}
