/*
 * Copyright 2020 Google Inc.
 *
 * 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.example.spanner;

//[START spanner_set_custom_timeout_and_retry]

import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.StatusCode.Code;
import com.google.cloud.spanner.DatabaseClient;
import com.google.cloud.spanner.DatabaseId;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.Statement;
import org.threeten.bp.Duration;

class CustomTimeoutAndRetrySettingsExample {

  static void executeSqlWithCustomTimeoutAndRetrySettings() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    String databaseId = "my-database";

    executeSqlWithCustomTimeoutAndRetrySettings(projectId, instanceId, databaseId);
  }

  // Create a Spanner client with custom ExecuteSql timeout and retry settings.
  static void executeSqlWithCustomTimeoutAndRetrySettings(
      String projectId, String instanceId, String databaseId) {
    SpannerOptions.Builder builder = SpannerOptions.newBuilder().setProjectId(projectId);
    // Set custom timeout and retry settings for the ExecuteSql RPC.
    // This must be done in a separate chain as the setRetryableCodes and setRetrySettings methods
    // return a UnaryCallSettings.Builder instead of a SpannerOptions.Builder.
    builder
        .getSpannerStubSettingsBuilder()
        .executeSqlSettings()
        // Configure which errors should be retried.
        .setRetryableCodes(Code.DEADLINE_EXCEEDED, Code.UNAVAILABLE)
        .setRetrySettings(
            RetrySettings.newBuilder()
                // Configure retry delay settings.
                .setInitialRetryDelay(Duration.ofMillis(500))
                .setMaxRetryDelay(Duration.ofSeconds(64))
                .setRetryDelayMultiplier(1.5)

                // Configure RPC and total timeout settings.
                .setInitialRpcTimeout(Duration.ofSeconds(60))
                .setMaxRpcTimeout(Duration.ofSeconds(60))
                .setRpcTimeoutMultiplier(1.0)
                .setTotalTimeout(Duration.ofSeconds(60))
                .build());
    // Create a Spanner client using the custom retry and timeout settings.
    try (Spanner spanner = builder.build().getService()) {
      DatabaseClient client =
          spanner.getDatabaseClient(DatabaseId.of(projectId, instanceId, databaseId));
      client
          .readWriteTransaction()
          .run(transaction -> {
            String sql =
                "INSERT Singers (SingerId, FirstName, LastName)\n"
                    + "VALUES (20, 'George', 'Washington')";
            long rowCount = transaction.executeUpdate(Statement.of(sql));
            System.out.printf("%d record inserted.%n", rowCount);
            return null;
          });
    }
  }
}
// [END spanner_set_custom_timeout_and_retry]

@@ -2288,111 +2288,533 @@
     
-.setInitialRetryDelay(Duration.ofMillis(500))%0A                .setMaxRetryDelay(Duration.ofSeconds(64))
+// The initial amount of time to wait before retrying the request.%0A                .setInitialRetryDelay(Duration.ofMillis(500))%0A                // The maximum amount of time to wait before retrying. I.e. after this value is%0A                // reached, the wait time will not increase further by the multiplier.%0A                .setMaxRetryDelay(Duration.ofSeconds(64))%0A                // The previous wait time is multiplied by this multiplier to come up with the next%0A                // wait time, until the max is reached.
 %0A   
@@ -2910,32 +2910,132 @@
 meout settings.%0A
+                // Timeout for the first RPC call. Subsequent retries will be based off this value.%0A
                 
@@ -3072,32 +3072,84 @@
 .ofSeconds(60))%0A
+                // The max for the per RPC timeout.%0A
                 
@@ -3210,37 +3210,176 @@
     
-.setRpcTimeoutMultiplier(1.0)
+// Controls the change of timeout for each retry.%0A                .setRpcTimeoutMultiplier(1.0)%0A                // The timeout for all calls (first call + all retries).
 %0A   

document retry settings in sample (#1214)