org.apache.hadoop.fs.s3a.impl.PutObjectOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hadoop-aws Show documentation

This module contains code to support integration with Amazon Web Services. It also declares the dependencies needed to work with AWS services.

There is a newer version: 3.4.1

Show newest version

/*
 * 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.hadoop.fs.s3a.impl;

import java.util.Map;
import javax.annotation.Nullable;

/**
 * Extensible structure for options when putting/writing objects.
 */
public final class PutObjectOptions {

  /**
   * Can the PUT operation skip marker deletion?
   */
  private final boolean keepMarkers;

  /**
   * Storage class, if not null.
   */
  private final String storageClass;

  /**
   * Headers; may be null.
   */
  private final Map headers;

  /**
   * Constructor.
   * @param keepMarkers Can the PUT operation skip marker deletion?
   * @param storageClass Storage class, if not null.
   * @param headers Headers; may be null.
   */
  public PutObjectOptions(
      final boolean keepMarkers,
      @Nullable final String storageClass,
      @Nullable final Map headers) {
    this.keepMarkers = keepMarkers;
    this.storageClass = storageClass;
    this.headers = headers;
  }

  /**
   * Get the marker retention flag.
   * @return true if markers are to be retained.
   */
  public boolean isKeepMarkers() {
    return keepMarkers;
  }

  /**
   * Headers for the put/post request.
   * @return headers or null.
   */
  public Map getHeaders() {
    return headers;
  }

  @Override
  public String toString() {
    return "PutObjectOptions{" +
        "keepMarkers=" + keepMarkers +
        ", storageClass='" + storageClass + '\'' +
        '}';
  }

  private static final PutObjectOptions KEEP_DIRS = new PutObjectOptions(true,
      null, null);
  private static final PutObjectOptions DELETE_DIRS = new PutObjectOptions(false,
      null, null);

  /**
   * Get the options to keep directories.
   * @return an instance which keeps dirs
   */
  public static PutObjectOptions keepingDirs() {
    return KEEP_DIRS;
  }

  /**
   * Get the options to delete directory markers.
   * @return an instance which deletes dirs
   */
  public static PutObjectOptions deletingDirs() {
    return DELETE_DIRS;
  }

}