alluxio.job.LoadJobRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alluxio-core-common Show documentation

Common utilities shared in Alluxio core modules

There is a newer version: 313

/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.job;

import alluxio.grpc.LoadJobPOptions;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;

import javax.annotation.concurrent.ThreadSafe;

/**
 * The request of loading files.
 */
@ThreadSafe
public class LoadJobRequest implements JobRequest {
  private static final String TYPE = "load";
  private static final long serialVersionUID = -4100882786127020489L;
  private final String mPath;
  private final LoadJobPOptions mOptions;

  /**
   * @param path the file path
   * @param options load job options
   **/
  public LoadJobRequest(@JsonProperty("path") String path,
      @JsonProperty("loadJobPOptions") LoadJobPOptions options) {
    mPath = Preconditions.checkNotNull(path, "The file path cannot be null");
    mOptions = Preconditions.checkNotNull(options, "The load job options cannot be null");
  }

  /**
   * @return the file path
   */
  public String getPath() {
    return mPath;
  }

  /**
   * @return job options
   */
  public LoadJobPOptions getOptions() {
    return mOptions;
  }

  @Override
  public String toString() {
    return MoreObjects
        .toStringHelper(this)
        .add("Path", mPath)
        .add("Options", mOptions)
        .toString();
  }

  @Override
  public String getType() {
    return TYPE;
  }
}