| /* |
| * 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.beam.runners.samza; |
| |
| import com.fasterxml.jackson.annotation.JsonIgnore; |
| import java.util.List; |
| import java.util.Map; |
| import org.apache.beam.sdk.options.Default; |
| import org.apache.beam.sdk.options.Description; |
| import org.apache.beam.sdk.options.PipelineOptions; |
| import org.apache.samza.config.ConfigFactory; |
| import org.apache.samza.config.factories.PropertiesConfigFactory; |
| import org.apache.samza.metrics.MetricsReporter; |
| |
| /** Options which can be used to configure a Samza PortablePipelineRunner. */ |
| public interface SamzaPipelineOptions extends PipelineOptions { |
| |
| @Description( |
| "The config file for Samza. It is *optional*. By default Samza supports properties config." |
| + "Without a config file, Samza uses a default config for local execution.") |
| String getConfigFilePath(); |
| |
| void setConfigFilePath(String filePath); |
| |
| @Description("The factory to read config file from config file path.") |
| @Default.Class(PropertiesConfigFactory.class) |
| Class<? extends ConfigFactory> getConfigFactory(); |
| |
| void setConfigFactory(Class<? extends ConfigFactory> configFactory); |
| |
| @Description( |
| "The config override to set programmatically. It will be applied on " |
| + "top of config file if it exits, otherwise used directly as the config.") |
| Map<String, String> getConfigOverride(); |
| |
| void setConfigOverride(Map<String, String> configs); |
| |
| @Description("The instance name of the job") |
| @Default.String("1") |
| String getJobInstance(); |
| |
| void setJobInstance(String instance); |
| |
| @Description( |
| "Samza application execution environment." |
| + "See {@link org.apache.beam.runners.samza.SamzaExecutionEnvironment} for detailed environment descriptions.") |
| @Default.Enum("LOCAL") |
| SamzaExecutionEnvironment getSamzaExecutionEnvironment(); |
| |
| void setSamzaExecutionEnvironment(SamzaExecutionEnvironment environment); |
| |
| @Description("The interval to check for watermarks in milliseconds.") |
| @Default.Long(1000) |
| long getWatermarkInterval(); |
| |
| void setWatermarkInterval(long interval); |
| |
| @Description("The maximum number of messages to buffer for a given system.") |
| @Default.Integer(5000) |
| int getSystemBufferSize(); |
| |
| void setSystemBufferSize(int consumerBufferSize); |
| |
| @Description("The maximum parallelism allowed for any data source.") |
| @Default.Integer(1) |
| int getMaxSourceParallelism(); |
| |
| void setMaxSourceParallelism(int maxSourceParallelism); |
| |
| @Description("The batch get size limit for the state store.") |
| @Default.Integer(10000) |
| int getStoreBatchGetSize(); |
| |
| void setStoreBatchGetSize(int storeBatchGetSize); |
| |
| @Description("Enable/disable Beam metrics in Samza Runner") |
| @Default.Boolean(true) |
| Boolean getEnableMetrics(); |
| |
| void setEnableMetrics(Boolean enableMetrics); |
| |
| @Description("The config for state to be durable") |
| @Default.Boolean(false) |
| Boolean getStateDurable(); |
| |
| void setStateDurable(Boolean stateDurable); |
| |
| @Description("The maximum number of event-time timers buffered in memory for a transform.") |
| @Default.Integer(50000) |
| int getTimerBufferSize(); |
| |
| void setTimerBufferSize(int timerBufferSize); |
| |
| @JsonIgnore |
| @Description("The metrics reporters that will be used to emit metrics.") |
| List<MetricsReporter> getMetricsReporters(); |
| |
| void setMetricsReporters(List<MetricsReporter> reporters); |
| } |