1 /* 2 * Copyright 2018 Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 package com.google.api.gax.retrying; 31 32 import com.google.api.core.BetaApi; 33 import com.google.api.gax.rpc.StatusCode; 34 import com.google.api.gax.tracing.ApiTracer; 35 import java.util.Set; 36 import javax.annotation.Nonnull; 37 import javax.annotation.Nullable; 38 39 /** 40 * Context for a retryable operation. 41 * 42 * <p>It provides state to individual {@link RetryingFuture}s via the {@link RetryingExecutor}. 43 */ 44 @BetaApi("The surface for passing per operation state is not yet stable") 45 public interface RetryingContext { 46 /** Returns the {@link ApiTracer} associated with the current operation. */ 47 @Nonnull getTracer()48 ApiTracer getTracer(); 49 50 /** 51 * Returns the {@link RetrySettings} to use with this context, or <code>null</code> if the default 52 * {@link RetrySettings} should be used. 53 */ 54 @Nullable getRetrySettings()55 RetrySettings getRetrySettings(); 56 57 /** 58 * Returns the retryable codes to use with this context, or <code>null</code> if the default 59 * retryable codes should be used. 60 */ 61 @Nullable getRetryableCodes()62 Set<StatusCode.Code> getRetryableCodes(); 63 } 64