com.google.cloud.storage.transfermanager.DownloadJob Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-storage Show documentation
Java idiomatic client for Google Cloud Storage.
There is a newer version: 2.45.0
/*
 * Copyright 2023 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.storage.transfermanager;

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

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.rpc.ApiExceptions;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;
import java.util.List;
import java.util.Objects;
import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
import org.checkerframework.checker.nullness.qual.NonNull;

/**
 * A parallel download job sent to Transfer Manager.
 *
 * @see Builder
 */
@BetaApi
public final class DownloadJob {

  @NonNull private final List> downloadResults;

  @NonNull private final ParallelDownloadConfig parallelDownloadConfig;

  private DownloadJob(
      @NonNull List> downloadResults,
      @NonNull ParallelDownloadConfig parallelDownloadConfig) {
    this.downloadResults = downloadResults;
    this.parallelDownloadConfig = parallelDownloadConfig;
  }

  /**
   * The list of {@link DownloadResult DownloadResults} for each download request Transfer Manager
   * executed for this job. Note calling this method will block the invoking thread until all
   * download requests are complete.
   *
   * @see Builder#setDownloadResults(List)
   */
  @BetaApi
  public @NonNull List getDownloadResults() {
    return ApiExceptions.callAndTranslateApiException(ApiFutures.allAsList(downloadResults));
  }

  /**
   * The {@link ParallelDownloadConfig} used for this DownloadJob.
   *
   * @see Builder#setParallelDownloadConfig(ParallelDownloadConfig)
   */
  @BetaApi
  public @NonNull ParallelDownloadConfig getParallelDownloadConfig() {
    return parallelDownloadConfig;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!(o instanceof DownloadJob)) {
      return false;
    }
    DownloadJob that = (DownloadJob) o;
    return downloadResults.equals(that.downloadResults)
        && parallelDownloadConfig.equals(that.parallelDownloadConfig);
  }

  @Override
  public int hashCode() {
    return Objects.hash(downloadResults, parallelDownloadConfig);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("downloadResults", downloadResults)
        .add("parallelDownloadConfig", parallelDownloadConfig)
        .toString();
  }

  @BetaApi
  public static Builder newBuilder() {
    return new Builder();
  }

  /**
   * Builds an instance of DownloadJob
   *
   * @see DownloadJob
   */
  @BetaApi
  public static final class Builder {

    private @NonNull List> downloadResults;
    private @MonotonicNonNull ParallelDownloadConfig parallelDownloadConfig;

    private Builder() {
      this.downloadResults = ImmutableList.of();
    }

    /**
     * Sets the results for a DownloadJob being performed by Transfer Manager.
     *
     * @return the instance of the Builder with DownloadResults modified.
     * @see DownloadJob#getDownloadResults()
     */
    @BetaApi
    public Builder setDownloadResults(@NonNull List> downloadResults) {
      this.downloadResults = ImmutableList.copyOf(downloadResults);
      return this;
    }

    /**
     * Sets the {@link ParallelDownloadConfig} used for this DownloadJob.
     *
     * @return the instance of the Builder with ParallelDownloadConfig modified.
     * @see DownloadJob#getParallelDownloadConfig()
     */
    @BetaApi
    public Builder setParallelDownloadConfig(
        @NonNull ParallelDownloadConfig parallelDownloadConfig) {
      this.parallelDownloadConfig = parallelDownloadConfig;
      return this;
    }

    /**
     * Creates a DownloadJob object.
     *
     * @return {@link DownloadJob}
     */
    @BetaApi
    public DownloadJob build() {
      checkNotNull(downloadResults);
      checkNotNull(parallelDownloadConfig);
      return new DownloadJob(downloadResults, parallelDownloadConfig);
    }
  }
}