examples/cloud-datafusion-functions-plugins/src/main/java/com/google/cloud/pso/common/GCPReferenceSinkConfig.java
/*
 * Copyright 2021 Google LLC
 *
 * 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.google.cloud.pso.common;

import io.cdap.cdap.api.annotation.Description;
import io.cdap.cdap.api.annotation.Macro;
import io.cdap.cdap.api.annotation.Name;
import io.cdap.plugin.common.IdUtils;

/** Reference config extending GCPConfig for sinks. */
public class GCPReferenceSinkConfig extends GCPConfig {
  @Name("referenceName")
  @Description(
      "This will be used to uniquely identify this sink for lineage, annotating metadata, etc.")
  @Macro
  protected String referenceName;

  /** Validates the given referenceName to consists of characters allowed to represent a dataset. */
  public void validate() {
    IdUtils.validateId(referenceName);
  }

  public String getReferenceName() {
    return referenceName;
  }
}
