com.google.cloud.storage.spi.StorageRpc Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gcloud-java-storage Show documentation
Show all versions of gcloud-java-storage Show documentation
Java idiomatic client for Google Cloud Storage.
The newest version!
/*
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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.spi;
import com.google.api.services.storage.model.Bucket;
import com.google.api.services.storage.model.StorageObject;
import com.google.cloud.storage.StorageException;
import java.io.InputStream;
import java.util.Map;
import java.util.Objects;
public interface StorageRpc {
// These options are part of the Google Cloud storage header options
enum Option {
PREDEFINED_ACL("predefinedAcl"),
PREDEFINED_DEFAULT_OBJECT_ACL("predefinedDefaultObjectAcl"),
IF_METAGENERATION_MATCH("ifMetagenerationMatch"),
IF_METAGENERATION_NOT_MATCH("ifMetagenerationNotMatch"),
IF_GENERATION_MATCH("ifGenerationMatch"),
IF_GENERATION_NOT_MATCH("ifGenerationNotMatch"),
IF_SOURCE_METAGENERATION_MATCH("ifSourceMetagenerationMatch"),
IF_SOURCE_METAGENERATION_NOT_MATCH("ifSourceMetagenerationNotMatch"),
IF_SOURCE_GENERATION_MATCH("ifSourceGenerationMatch"),
IF_SOURCE_GENERATION_NOT_MATCH("ifSourceGenerationNotMatch"),
PREFIX("prefix"),
MAX_RESULTS("maxResults"),
PAGE_TOKEN("pageToken"),
DELIMITER("delimiter"),
VERSIONS("versions"),
FIELDS("fields");
private final String value;
Option(String value) {
this.value = value;
}
public String value() {
return value;
}
@SuppressWarnings("unchecked")
T get(Map options) {
return (T) options.get(this);
}
String getString(Map options) {
return get(options);
}
Long getLong(Map options) {
return get(options);
}
Boolean getBoolean(Map options) {
return get(options);
}
}
class Tuple {
private final X x;
private final Y y;
private Tuple(X x, Y y) {
this.x = x;
this.y = y;
}
public static Tuple of(X x, Y y) {
return new Tuple<>(x, y);
}
public X x() {
return x;
}
public Y y() {
return y;
}
}
class RewriteRequest {
public final StorageObject source;
public final Map sourceOptions;
public final boolean overrideInfo;
public final StorageObject target;
public final Map targetOptions;
public final Long megabytesRewrittenPerCall;
public RewriteRequest(StorageObject source, Map sourceOptions,
boolean overrideInfo, StorageObject target, Map targetOptions,
Long megabytesRewrittenPerCall) {
this.source = source;
this.sourceOptions = sourceOptions;
this.overrideInfo = overrideInfo;
this.target = target;
this.targetOptions = targetOptions;
this.megabytesRewrittenPerCall = megabytesRewrittenPerCall;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (!(obj instanceof RewriteRequest)) {
return false;
}
final RewriteRequest other = (RewriteRequest) obj;
return Objects.equals(this.source, other.source)
&& Objects.equals(this.sourceOptions, other.sourceOptions)
&& Objects.equals(this.overrideInfo, other.overrideInfo)
&& Objects.equals(this.target, other.target)
&& Objects.equals(this.targetOptions, other.targetOptions)
&& Objects.equals(this.megabytesRewrittenPerCall, other.megabytesRewrittenPerCall);
}
@Override
public int hashCode() {
return Objects.hash(source, sourceOptions, overrideInfo, target, targetOptions,
megabytesRewrittenPerCall);
}
}
class RewriteResponse {
public final RewriteRequest rewriteRequest;
public final StorageObject result;
public final long blobSize;
public final boolean isDone;
public final String rewriteToken;
public final long totalBytesRewritten;
public RewriteResponse(RewriteRequest rewriteRequest, StorageObject result, long blobSize,
boolean isDone, String rewriteToken, long totalBytesRewritten) {
this.rewriteRequest = rewriteRequest;
this.result = result;
this.blobSize = blobSize;
this.isDone = isDone;
this.rewriteToken = rewriteToken;
this.totalBytesRewritten = totalBytesRewritten;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (!(obj instanceof RewriteResponse)) {
return false;
}
final RewriteResponse other = (RewriteResponse) obj;
return Objects.equals(this.rewriteRequest, other.rewriteRequest)
&& Objects.equals(this.result, other.result)
&& Objects.equals(this.rewriteToken, other.rewriteToken)
&& this.blobSize == other.blobSize
&& Objects.equals(this.isDone, other.isDone)
&& this.totalBytesRewritten == other.totalBytesRewritten;
}
@Override
public int hashCode() {
return Objects.hash(rewriteRequest, result, blobSize, isDone, rewriteToken,
totalBytesRewritten);
}
}
/**
* Creates a new bucket.
*
* @throws StorageException upon failure
*/
Bucket create(Bucket bucket, Map options);
/**
* Creates a new storage object.
*
* @throws StorageException upon failure
*/
StorageObject create(StorageObject object, InputStream content, Map options);
/**
* Lists the project's buckets.
*
* @throws StorageException upon failure
*/
Tuple> list(Map options);
/**
* Lists the bucket's blobs.
*
* @throws StorageException upon failure
*/
Tuple> list(String bucket, Map options);
/**
* Returns the requested bucket or {@code null} if not found.
*
* @throws StorageException upon failure
*/
Bucket get(Bucket bucket, Map options);
/**
* Returns the requested storage object or {@code null} if not found.
*
* @throws StorageException upon failure
*/
StorageObject get(StorageObject object, Map options);
/**
* Updates bucket information.
*
* @throws StorageException upon failure
*/
Bucket patch(Bucket bucket, Map options);
/**
* Updates the storage object's information. Original metadata are merged with metadata in the
* provided {@code storageObject}.
*
* @throws StorageException upon failure
*/
StorageObject patch(StorageObject storageObject, Map options);
/**
* Deletes the requested bucket.
*
* @return {@code true} if the bucket was deleted, {@code false} if it was not found
* @throws StorageException upon failure
*/
boolean delete(Bucket bucket, Map options);
/**
* Deletes the requested storage object.
*
* @return {@code true} if the storage object was deleted, {@code false} if it was not found
* @throws StorageException upon failure
*/
boolean delete(StorageObject object, Map options);
/**
* Creates an empty batch.
*/
RpcBatch createBatch();
/**
* Sends a compose request.
*
* @throws StorageException upon failure
*/
StorageObject compose(Iterable sources, StorageObject target,
Map targetOptions);
/**
* Reads all the bytes from a storage object.
*
* @throws StorageException upon failure
*/
byte[] load(StorageObject storageObject, Map options);
/**
* Reads the given amount of bytes from a storage object at the given position.
*
* @throws StorageException upon failure
*/
Tuple read(StorageObject from, Map options, long position, int bytes);
/**
* Opens a resumable upload channel for a given storage object.
*
* @throws StorageException upon failure
*/
String open(StorageObject object, Map options);
/**
* Writes the provided bytes to a storage object at the provided location.
*
* @throws StorageException upon failure
*/
void write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length,
boolean last);
/**
* Sends a rewrite request to open a rewrite channel.
*
* @throws StorageException upon failure
*/
RewriteResponse openRewrite(RewriteRequest rewriteRequest);
/**
* Continues rewriting on an already open rewrite channel.
*
* @throws StorageException upon failure
*/
RewriteResponse continueRewrite(RewriteResponse previousResponse);
}