org.apache.pulsar.common.functions.FunctionConfig Maven / Gradle / Ivy
/**
* 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.pulsar.common.functions;
import java.util.Collection;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.pulsar.client.api.SubscriptionInitialPosition;
/**
* Configuration of Pulsar Function.
*/
@Data
@Builder(toBuilder = true)
@NoArgsConstructor
@AllArgsConstructor
public class FunctionConfig {
/**
* Definition of possible processing guarantees.
*/
public enum ProcessingGuarantees {
ATLEAST_ONCE,
ATMOST_ONCE,
EFFECTIVELY_ONCE
}
/**
* Definition of possible runtime environments.
*/
public enum Runtime {
JAVA,
PYTHON,
GO
}
// Any flags that you want to pass to the runtime.
// note that in thread mode, these flags will have no impact
private String runtimeFlags;
private String tenant;
private String namespace;
private String name;
private String className;
private Collection inputs;
private Map customSerdeInputs;
private String topicsPattern;
private Map customSchemaInputs;
private Map customSchemaOutputs;
/**
* A generalized way of specifying inputs.
*/
private Map inputSpecs;
private String output;
// Any configuration that need to be applied for producers
private ProducerConfig producerConfig;
/**
* Represents either a builtin schema type (eg: 'avro', 'json', ect) or the class name for a Schema
* implementation.
*/
private String outputSchemaType;
private String outputSerdeClassName;
private String logTopic;
private ProcessingGuarantees processingGuarantees;
// Do we want function instances to process data in the same order as in the input topics
// This essentially means that every partition of input topic is consumed by only one instance
private Boolean retainOrdering;
// Do we want the same function instance to process all data keyed by the input topic's message key
private Boolean retainKeyOrdering;
// batchBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED
private String batchBuilder;
private Boolean forwardSourceMessageProperty;
private Map userConfig;
// This is a map of secretName(aka how the secret is going to be
// accessed in the function via context) to an object that
// encapsulates how the secret is fetched by the underlying
// secrets provider. The type of an value here can be found by the
// SecretProviderConfigurator.getSecretObjectType() method.
private Map secrets;
private Runtime runtime;
private Boolean autoAck;
private Integer maxMessageRetries;
private String deadLetterTopic;
private String subName;
private Integer parallelism;
private Resources resources;
private String fqfn;
private WindowConfig windowConfig;
private Long timeoutMs;
private String jar;
private String py;
private String go;
// Whether the subscriptions the functions created/used should be deleted when the functions is deleted
private Boolean cleanupSubscription;
// This is an arbitrary string that can be interpreted by the function runtime
// to change behavior at runtime. Currently, this primarily used by the KubernetesManifestCustomizer
// interface
private String customRuntimeOptions;
// Max pending async requests per instance to avoid large number of concurrent requests.
// Only used in AsyncFunction. Default: 1000.
private Integer maxPendingAsyncRequests;
// Whether the pulsar admin client exposed to function context, default is disabled.
private Boolean exposePulsarAdminClientEnabled;
private SubscriptionInitialPosition subscriptionPosition;
}