sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigtable/BigtableWriteResult.java

/*
 * 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.sdk.io.gcp.bigtable;

import com.google.auto.value.AutoValue;
import org.apache.beam.sdk.coders.DefaultCoder;

/**
 * The result of writing a batch of rows to Bigtable. Rows are written to bigtable in batches (based
 * on the runner-chosen bundle size). Once each batch finishes, a single {@link BigtableWriteResult}
 * is emitted.
 */
@DefaultCoder(BigtableWriteResultCoder.class)
@AutoValue
public abstract class BigtableWriteResult {
  public static BigtableWriteResult create(long rowsWritten) {
    return new AutoValue_BigtableWriteResult(rowsWritten);
  }

  /** The number of rows written in this batch. */
  public abstract long getRowsWritten();
}