org.apache.iceberg.flink.source.assigner.GetSplitResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iceberg-flink-1.18 Show documentation

A table format for huge analytic datasets

There is a newer version: 1.7.0

/*
 * 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.iceberg.flink.source.assigner;

import org.apache.flink.annotation.Internal;
import org.apache.flink.util.Preconditions;
import org.apache.iceberg.flink.source.split.IcebergSourceSplit;

@Internal
public class GetSplitResult {

  public enum Status {
    AVAILABLE,

    /**
     * There are pending splits. But they can't be assigned due to constraints (like event time
     * alignment)
     */
    CONSTRAINED,

    /** Assigner doesn't have pending splits. */
    UNAVAILABLE
  }

  private final Status status;
  private final IcebergSourceSplit split;

  private GetSplitResult(Status status) {
    this.status = status;
    this.split = null;
  }

  private GetSplitResult(IcebergSourceSplit split) {
    Preconditions.checkNotNull(split, "Split cannot be null");
    this.status = Status.AVAILABLE;
    this.split = split;
  }

  public Status status() {
    return status;
  }

  public IcebergSourceSplit split() {
    return split;
  }

  private static final GetSplitResult UNAVAILABLE = new GetSplitResult(Status.UNAVAILABLE);
  private static final GetSplitResult CONSTRAINED = new GetSplitResult(Status.CONSTRAINED);

  public static GetSplitResult unavailable() {
    return UNAVAILABLE;
  }

  public static GetSplitResult constrained() {
    return CONSTRAINED;
  }

  public static GetSplitResult forSplit(IcebergSourceSplit split) {
    return new GetSplitResult(split);
  }
}