org.apache.hudi.utilities.config.HoodieSchemaProviderConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudi-cli-bundle_2.13 Show documentation
The newest version!
/*
 * 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.hudi.utilities.config;

import org.apache.hudi.common.config.ConfigClassProperty;
import org.apache.hudi.common.config.ConfigGroups;
import org.apache.hudi.common.config.ConfigProperty;
import org.apache.hudi.common.config.HoodieConfig;

import javax.annotation.concurrent.Immutable;

import static org.apache.hudi.common.util.ConfigUtils.OLD_SCHEMAPROVIDER_CONFIG_PREFIX;
import static org.apache.hudi.common.util.ConfigUtils.SCHEMAPROVIDER_CONFIG_PREFIX;

/**
 * Hudi Streamer Schema Provider related config.
 */
@Immutable
@ConfigClassProperty(name = "Hudi Streamer Schema Provider Configs",
    groupName = ConfigGroups.Names.HUDI_STREAMER,
    subGroupName = ConfigGroups.SubGroupNames.SCHEMA_PROVIDER,
    areCommonConfigs = true,
    description = "")
public class HoodieSchemaProviderConfig extends HoodieConfig {

  public static final ConfigProperty SRC_SCHEMA_REGISTRY_URL = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.url")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.url")
      .withDocumentation("The schema of the source you are reading from e.g. https://foo:[email protected]");

  public static final ConfigProperty TARGET_SCHEMA_REGISTRY_URL = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.targetUrl")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.targetUrl")
      .withDocumentation("The schema of the target you are writing to e.g. https://foo:[email protected]");

  public static final ConfigProperty SCHEMA_CONVERTER = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.schemaconverter")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.schemaconverter")
      .markAdvanced()
      .withDocumentation("The class name of the custom schema converter to use.");

  public static final ConfigProperty SCHEMA_REGISTRY_BASE_URL = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.baseUrl")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.baseUrl")
      .markAdvanced()
      .withDocumentation("The base URL of the schema registry.");

  public static final ConfigProperty SCHEMA_REGISTRY_URL_SUFFIX = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.urlSuffix")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.urlSuffix")
      .markAdvanced()
      .withDocumentation("The suffix of the URL for the schema registry.");

  public static final ConfigProperty SCHEMA_REGISTRY_SOURCE_URL_SUFFIX = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.sourceUrlSuffix")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.sourceUrlSuffix")
      .markAdvanced()
      .withDocumentation("The source URL suffix.");

  public static final ConfigProperty SCHEMA_REGISTRY_TARGET_URL_SUFFIX = ConfigProperty
      .key(SCHEMAPROVIDER_CONFIG_PREFIX + "registry.targetUrlSuffix")
      .noDefaultValue()
      .withAlternatives(OLD_SCHEMAPROVIDER_CONFIG_PREFIX + "registry.targetUrlSuffix")
      .markAdvanced()
      .withDocumentation("The target URL suffix.");
}