/*
 * 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.examples.complete.cdap.salesforce.options;

import org.apache.beam.examples.complete.cdap.salesforce.CdapSalesforceStreamingToTxt;
import org.apache.beam.sdk.options.Description;
import org.apache.beam.sdk.options.Validation;

/**
 * The {@link CdapSalesforceStreamingSourceOptions} interface provides the custom execution options
 * passed by the executor at the command-line for {@link CdapSalesforceStreamingToTxt} example.
 */
public interface CdapSalesforceStreamingSourceOptions extends CdapSalesforceSourceOptions {

  @Validation.Required
  @Description("Salesforce push topic name. Plugin will track updates from this topic.")
  String getPushTopicName();

  void setPushTopicName(String pushTopicName);

  @Description("Delay in seconds between polling for new records updates.")
  Long getPullFrequencySec();

  void setPullFrequencySec(Long pullFrequencySec);

  @Description("Inclusive start offset from which the reading should be started.")
  Long getStartOffset();

  void setStartOffset(Long startOffset);
}
