com.google.cloud.storage.BidiBlobWriteSessionConfig 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 2024 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;

import com.google.api.core.ApiFuture;
import com.google.api.core.BetaApi;
import com.google.api.core.InternalApi;
import com.google.api.gax.grpc.GrpcCallContext;
import com.google.cloud.storage.DefaultBlobWriteSessionConfig.DecoratedWritableByteChannelSession;
import com.google.cloud.storage.DefaultBlobWriteSessionConfig.LazySession;
import com.google.cloud.storage.TransportCompatibility.Transport;
import com.google.common.base.Preconditions;
import com.google.storage.v2.BidiWriteObjectRequest;
import com.google.storage.v2.BidiWriteObjectResponse;
import java.io.IOException;
import java.time.Clock;
import java.util.Objects;
import javax.annotation.concurrent.Immutable;

/**
 * Perform a resumable upload, uploading at most {@code bufferSize} bytes each flush.
 *
 * Configuration of buffer size can be performed via {@link
 * BidiBlobWriteSessionConfig#withBufferSize(int)}.
 *
 * @since 2.34.0 This new api is in preview and is subject to breaking changes.
 */
@Immutable
@BetaApi
@TransportCompatibility({Transport.GRPC})
public final class BidiBlobWriteSessionConfig extends BlobWriteSessionConfig
    implements BlobWriteSessionConfig.GrpcCompatible {
  private static final long serialVersionUID = -903533790705476197L;

  private final int bufferSize;

  @InternalApi
  BidiBlobWriteSessionConfig(int bufferSize) {
    this.bufferSize = bufferSize;
  }

  /**
   * The number of bytes to hold in the buffer before each flush
   *
   * 
Default: {@code 16777216 (16 MiB)}
   *
   * @see #withBufferSize(int)
   * @since 2.34.0 This new api is in preview and is subject to breaking changes.
   */
  public int getBufferSize() {
    return bufferSize;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!(o instanceof BidiBlobWriteSessionConfig)) {
      return false;
    }
    BidiBlobWriteSessionConfig that = (BidiBlobWriteSessionConfig) o;
    return bufferSize == that.bufferSize;
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(bufferSize);
  }

  @Override
  WriterFactory createFactory(Clock clock) throws IOException {
    return new Factory(bufferSize);
  }

  @InternalApi
  private static final class Factory implements WriterFactory {
    private static final Conversions.Decoder
        WRITE_OBJECT_RESPONSE_BLOB_INFO_DECODER =
            Conversions.grpc().blobInfo().compose(BidiWriteObjectResponse::getResource);

    private final int bufferSize;

    private Factory(int bufferSize) {
      this.bufferSize = bufferSize;
    }

    @InternalApi
    @Override
    public WritableByteChannelSession writeSession(
        StorageInternal s, BlobInfo info, UnifiedOpts.Opts opts) {
      if (s instanceof GrpcStorageImpl) {
        return new DecoratedWritableByteChannelSession<>(
            new LazySession<>(
                new LazyWriteChannel<>(
                    () -> {
                      GrpcStorageImpl grpc = (GrpcStorageImpl) s;
                      GrpcCallContext grpcCallContext =
                          opts.grpcMetadataMapper().apply(GrpcCallContext.createDefault());
                      BidiWriteObjectRequest req = grpc.getBidiWriteObjectRequest(info, opts);

                      ApiFuture startResumableWrite =
                          grpc.startResumableWrite(grpcCallContext, req, opts);
                      return ResumableMedia.gapic()
                          .write()
                          .bidiByteChannel(grpc.storageClient.bidiWriteObjectCallable())
                          .setHasher(Hasher.noop())
                          .setByteStringStrategy(ByteStringStrategy.copy())
                          .resumable()
                          .withRetryConfig(
                              grpc.getOptions(), grpc.retryAlgorithmManager.idempotent())
                          .buffered(BufferHandle.allocate(bufferSize))
                          .setStartAsync(startResumableWrite)
                          .build();
                    })),
            WRITE_OBJECT_RESPONSE_BLOB_INFO_DECODER);
      } else {
        throw new IllegalStateException(
            "Unknown Storage implementation: " + s.getClass().getName());
      }
    }
  }

  /**
   * Create a new instance with the {@code bufferSize} set to the specified value.
   *
   * Default: {@code 16777216 (16 MiB)}
   *
   * @param bufferSize The number of bytes to hold in the buffer before each flush. Must be >=
   *     {@code 262144 (256 KiB)}
   * @return The new instance
   * @see #getBufferSize()
   * @since 2.34.0 This new api is in preview and is subject to breaking changes.
   */
  @BetaApi
  public BidiBlobWriteSessionConfig withBufferSize(int bufferSize) {
    Preconditions.checkArgument(
        bufferSize >= ByteSizeConstants._256KiB,
        "bufferSize must be >= %d",
        ByteSizeConstants._256KiB);
    return new BidiBlobWriteSessionConfig(bufferSize);
  }
}