com.spotify.dbeam.options.DBeamPipelineOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbeam-core Show documentation

Top level DBeam core implementation

There is a newer version: 0.10.27

/*-
 * -\-\-
 * DBeam Core
 * --
 * Copyright (C) 2016 - 2018 Spotify AB
 * --
 * Licensed 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 com.spotify.dbeam.options;

import org.apache.beam.sdk.options.Default;
import org.apache.beam.sdk.options.Description;
import org.apache.beam.sdk.options.PipelineOptions;
import org.apache.beam.sdk.options.Validation;

public interface DBeamPipelineOptions extends PipelineOptions {
  @Description("The JDBC connection url to perform the export.")
  @Validation.Required
  String getConnectionUrl();

  void setConnectionUrl(String value);

  @Description("The database table to query and perform the export.")
  String getTable();

  void setTable(String value);

  @Description("A path to a file containing a SQL query (used instead of --table parameter).")
  String getSqlFile();

  void setSqlFile(String value);

  @Description("The database user name used by JDBC to authenticate.")
  @Default.String("dbeam-extractor")
  String getUsername();

  void setUsername(String value);

  @Description("A path to a file containing the database password.")
  String getPasswordFile();

  void setPasswordFile(String value);

  @Description(
      "A path to a file containing the database password, KMS encrypted and base64 encoded.")
  String getPasswordFileKmsEncrypted();

  void setPasswordFileKmsEncrypted(String value);

  @Description("Plaintext password used by JDBC connection.")
  String getPassword();

  void setPassword(String value);

  @Description("DBeam version")
  String getDBeamVersion();

  void setDBeamVersion(String value);
}