com.google.cloud.hadoop.util.RetryHttpInitializerOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of util Show documentation
The newest version!
/*
 * Copyright 2020 Google LLC
 *
 * Licensed 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 com.google.cloud.hadoop.util;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableMap;
import java.time.Duration;
import java.util.Map;
import javax.annotation.Nullable;

/** Options for the {@link RetryHttpInitializer} class. */
@AutoValue
public abstract class RetryHttpInitializerOptions {

  public static final RetryHttpInitializerOptions DEFAULT = builder().build();

  public static Builder builder() {
    return new AutoValue_RetryHttpInitializerOptions.Builder()
        .setConnectTimeout(Duration.ofSeconds(5))
        .setDefaultUserAgent(null)
        .setHttpHeaders(ImmutableMap.of())
        .setMaxRequestRetries(10)
        .setReadTimeout(Duration.ofSeconds(5));
  }

  public abstract Builder toBuilder();

  /**
   * A String to set as the user-agent when initializing an HTTP request if it doesn't already have
   * a "User-Agent" header.
   */
  @Nullable
  public abstract String getDefaultUserAgent();

  /** An additional HTTP headers to set in an HTTP request. */
  public abstract ImmutableMap getHttpHeaders();

  /** A connection timeout - maximum time to wait until connection will be established. */
  public abstract Duration getConnectTimeout();

  /**
   * A read timeout from an established connection - maximum time to wait for a read form an
   * established connection to finish.
   */
  public abstract Duration getReadTimeout();

  /** A max number of retries for an HTTP request. */
  public abstract int getMaxRequestRetries();

  /** Builder for {@link RetryHttpInitializerOptions} */
  @AutoValue.Builder
  public abstract static class Builder {

    public abstract Builder setDefaultUserAgent(String userAgent);

    public abstract Builder setHttpHeaders(Map httpHeaders);

    public abstract Builder setConnectTimeout(Duration connectTimeout);

    public abstract Builder setReadTimeout(Duration readTimeout);

    public abstract Builder setMaxRequestRetries(int maxRequestRetries);

    abstract RetryHttpInitializerOptions autoBuild();

    public RetryHttpInitializerOptions build() {
      RetryHttpInitializerOptions options = autoBuild();
      checkArgument(
          options.getHttpHeaders().keySet().stream().noneMatch("User-Agent"::equalsIgnoreCase),
          "The User-Agent header must be provided via the defaultUserAgent option");
      return options;
    }
  }
}