content: /*
   * 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.dataflow.worker;
  
  import com.google.auto.service.AutoService;
  import java.util.Map;
  import java.util.ServiceLoader;
  import org.apache.beam.runners.dataflow.util.CloudObject;
  import org.apache.beam.runners.dataflow.worker.util.common.worker.Sink;
  import org.apache.beam.sdk.coders.Coder;
  import org.apache.beam.sdk.options.PipelineOptions;
  import org.checkerframework.checker.nullness.qual.Nullable;
  
  /** Constructs a {@link Sink} from a Dataflow service {@link CloudObject} specification. */
  @SuppressWarnings({
    "rawtypes" // TODO(https://github.com/apache/beam/issues/20447)
  })
  public interface SinkFactory {
  
    /** Creates a {@link Sink} from a Dataflow API Sink definition. */
    Sink<?> create(
        CloudObject sinkSpec,
        Coder<?> coder,
        @Nullable PipelineOptions options,
        @Nullable DataflowExecutionContext executionContext,
        DataflowOperationContext context)
        throws Exception;
  
    /**
     * A {@link ServiceLoader} interface used to install factories into the {@link
     * SinkRegistry#defaultRegistry() default SinkRegistry}.
     *
     * <p>It is optional but recommended to use one of the many build time tools such as {@link
     * AutoService} to generate the necessary META-INF files automatically.
     */
    interface Registrar {
  
      /**
       * Returns a mapping from a well known type to a {@link SinkFactory} capable of instantiating a
       * {@link Sink}
       *
       * <p>Each well known type is required to be unique among all registered sink factory
       * registrars.
       */
      Map<String, SinkFactory> factories();
    }
  }
  