com.google.cloud.storage.StorageRetryStrategy Maven / Gradle / Ivy
Show all versions of google-cloud-storage Show documentation
/*
* Copyright 2021 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.gax.retrying.ResultRetryAlgorithm;
import com.google.cloud.BaseService;
import java.io.Serializable;
/**
* A factory class which is used to provide access to {@link ResultRetryAlgorithm} for idempotent
* and non-idempotent calls made via {@link Storage}. Before {@link Storage} performs an operation
* it will determine if the operation is idempotent and select the appropriate {@link
* ResultRetryAlgorithm} to use for that invocation.
*
* @see #getDefaultStorageRetryStrategy()
* @see #getUniformStorageRetryStrategy()
*/
public interface StorageRetryStrategy extends Serializable {
/**
* Factory method to provide a {@link ResultRetryAlgorithm} which will be used to evaluate whether
* a retry can happen for an operation which has been deemed idempotent.
*
* @return
*/
ResultRetryAlgorithm getIdempotentHandler();
ResultRetryAlgorithm getNonidempotentHandler();
/**
* Factory method to get an instance of the default implementation of {@link
* StorageRetryStrategy}. The returned instance is provides handler which are appropriate for
* calls which are known to be idempotent vs non-idempotent.
*
* All non-idempotent calls will not be retried
*
*
The set of retryable cases handled by this strategy is more comprehensive than that of the
* legacy strategy and should always be preferred.
*
*
* Retried HTTP status codes for idempotent calls
*
* Code
* Name
*
*
* 408
* Request Timeout
*
*
* 429
* Too Many Requests
*
*
* 500
* Internal Server Error
*
*
* 502
* Bad Gateway
*
*
* 503
* Service Unavailable
*
*
* 504
* Gateway Timeout
*
*
*
* @see StorageOptions.Builder#setStorageRetryStrategy(StorageRetryStrategy)
* @see #getUniformStorageRetryStrategy()
*/
static StorageRetryStrategy getDefaultStorageRetryStrategy() {
return DefaultStorageRetryStrategy.INSTANCE;
}
/**
* Factory method to get an instance of {@link StorageRetryStrategy} which will uniformly retry
* all calls as if they were idempotent.
*
* NOTE:This strategy is unsafe and will result in retying some non-idempotent
* calls. Care should be taken to ensure calls which would not normally be considered idempotent
* are made idempotent by some other means in your program.
*
* @see StorageOptions.Builder#setStorageRetryStrategy(StorageRetryStrategy)
* @see #getDefaultStorageRetryStrategy()
*/
static StorageRetryStrategy getUniformStorageRetryStrategy() {
return new UniformStorageRetryStrategy(getDefaultStorageRetryStrategy().getIdempotentHandler());
}
/**
* Factory method to get an instance of {@link StorageRetryStrategy} with the behavior which was
* used prior to version 2.1.8. This strategy is unsafe and will result in retying some
* non-idempotent calls.
*
* @deprecated please migrate to using {@link #getDefaultStorageRetryStrategy()} which is capable
* of providing handlers which are appropriate for idempotent and non-idempotent calls.
* @see StorageOptions.Builder#setStorageRetryStrategy(StorageRetryStrategy)
* @see #getDefaultStorageRetryStrategy()
*/
@Deprecated
static StorageRetryStrategy getLegacyStorageRetryStrategy() {
return new UniformStorageRetryStrategy(BaseService.EXCEPTION_HANDLER);
}
}