On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if + * the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost + * track of the transaction outcome and we recommend that you perform another read from the + * database to see the state of things as they are now. + * * @param session Required. The session in which the transaction to be committed is running. * @param transactionId Commit a previously-started transaction. * @param mutations The mutations to be executed when this transaction commits. All mutations are @@ -751,6 +756,11 @@ public final CommitResponse commit( * reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the * beginning, re-using the same session. * + *
On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if + * the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost + * track of the transaction outcome and we recommend that you perform another read from the + * database to see the state of things as they are now. + * * @param session Required. The session in which the transaction to be committed is running. * @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike * commit of a previously-started transaction, commit with a temporary transaction is @@ -784,6 +794,11 @@ public final CommitResponse commit( * reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the * beginning, re-using the same session. * + *
On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if + * the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost + * track of the transaction outcome and we recommend that you perform another read from the + * database to see the state of things as they are now. + * * @param session Required. The session in which the transaction to be committed is running. * @param transactionId Commit a previously-started transaction. * @param mutations The mutations to be executed when this transaction commits. All mutations are @@ -811,6 +826,11 @@ public final CommitResponse commit( * reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the * beginning, re-using the same session. * + *
On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if + * the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost + * track of the transaction outcome and we recommend that you perform another read from the + * database to see the state of things as they are now. + * * @param session Required. The session in which the transaction to be committed is running. * @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike * commit of a previously-started transaction, commit with a temporary transaction is @@ -844,6 +864,11 @@ public final CommitResponse commit( * reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the * beginning, re-using the same session. * + *
On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if + * the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost + * track of the transaction outcome and we recommend that you perform another read from the + * database to see the state of things as they are now. + * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -861,6 +886,11 @@ public final CommitResponse commit(CommitRequest request) { * reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the * beginning, re-using the same session. * + *
On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if + * the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost + * track of the transaction outcome and we recommend that you perform another read from the + * database to see the state of things as they are now. + * *
Sample code:
*/
public final UnaryCallable
+ * If `true`, then statistics related to the transaction will be included in
+ * the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
+ * `false`.
+ *
+ *
+ * bool return_commit_stats = 5;
+ *
+ * @return The returnCommitStats.
+ */
+ @java.lang.Override
+ public boolean getReturnCommitStats() {
+ return returnCommitStats_;
+ }
+
private byte memoizedIsInitialized = -1;
@java.lang.Override
@@ -448,6 +473,9 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
for (int i = 0; i < mutations_.size(); i++) {
output.writeMessage(4, mutations_.get(i));
}
+ if (returnCommitStats_ != false) {
+ output.writeBool(5, returnCommitStats_);
+ }
unknownFields.writeTo(output);
}
@@ -473,6 +501,9 @@ public int getSerializedSize() {
for (int i = 0; i < mutations_.size(); i++) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, mutations_.get(i));
}
+ if (returnCommitStats_ != false) {
+ size += com.google.protobuf.CodedOutputStream.computeBoolSize(5, returnCommitStats_);
+ }
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
@@ -490,6 +521,7 @@ public boolean equals(final java.lang.Object obj) {
if (!getSession().equals(other.getSession())) return false;
if (!getMutationsList().equals(other.getMutationsList())) return false;
+ if (getReturnCommitStats() != other.getReturnCommitStats()) return false;
if (!getTransactionCase().equals(other.getTransactionCase())) return false;
switch (transactionCase_) {
case 2:
@@ -518,6 +550,8 @@ public int hashCode() {
hash = (37 * hash) + MUTATIONS_FIELD_NUMBER;
hash = (53 * hash) + getMutationsList().hashCode();
}
+ hash = (37 * hash) + RETURN_COMMIT_STATS_FIELD_NUMBER;
+ hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(getReturnCommitStats());
switch (transactionCase_) {
case 2:
hash = (37 * hash) + TRANSACTION_ID_FIELD_NUMBER;
@@ -684,6 +718,8 @@ public Builder clear() {
} else {
mutationsBuilder_.clear();
}
+ returnCommitStats_ = false;
+
transactionCase_ = 0;
transaction_ = null;
return this;
@@ -733,6 +769,7 @@ public com.google.spanner.v1.CommitRequest buildPartial() {
} else {
result.mutations_ = mutationsBuilder_.build();
}
+ result.returnCommitStats_ = returnCommitStats_;
result.transactionCase_ = transactionCase_;
onBuilt();
return result;
@@ -814,6 +851,9 @@ public Builder mergeFrom(com.google.spanner.v1.CommitRequest other) {
}
}
}
+ if (other.getReturnCommitStats() != false) {
+ setReturnCommitStats(other.getReturnCommitStats());
+ }
switch (other.getTransactionCase()) {
case TRANSACTION_ID:
{
@@ -1712,6 +1752,64 @@ public java.util.List
+ * If `true`, then statistics related to the transaction will be included in
+ * the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
+ * `false`.
+ *
+ *
+ * bool return_commit_stats = 5;
+ *
+ * @return The returnCommitStats.
+ */
+ @java.lang.Override
+ public boolean getReturnCommitStats() {
+ return returnCommitStats_;
+ }
+ /**
+ *
+ *
+ *
+ * If `true`, then statistics related to the transaction will be included in
+ * the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
+ * `false`.
+ *
+ *
+ * bool return_commit_stats = 5;
+ *
+ * @param value The returnCommitStats to set.
+ * @return This builder for chaining.
+ */
+ public Builder setReturnCommitStats(boolean value) {
+
+ returnCommitStats_ = value;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * If `true`, then statistics related to the transaction will be included in
+ * the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
+ * `false`.
+ *
+ *
+ * bool return_commit_stats = 5;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearReturnCommitStats() {
+
+ returnCommitStats_ = false;
+ onChanged();
+ return this;
+ }
+
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitRequestOrBuilder.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitRequestOrBuilder.java
index bb0f6c6acdd..a32fa4b4396 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitRequestOrBuilder.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitRequestOrBuilder.java
@@ -185,5 +185,20 @@ public interface CommitRequestOrBuilder
*/
com.google.spanner.v1.MutationOrBuilder getMutationsOrBuilder(int index);
+ /**
+ *
+ *
+ *
+ * If `true`, then statistics related to the transaction will be included in
+ * the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
+ * `false`.
+ *
+ *
+ * bool return_commit_stats = 5;
+ *
+ * @return The returnCommitStats.
+ */
+ boolean getReturnCommitStats();
+
public com.google.spanner.v1.CommitRequest.TransactionCase getTransactionCase();
}
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponse.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponse.java
index 28772858452..320d165cf94 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponse.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponse.java
@@ -81,6 +81,22 @@ private CommitResponse(
commitTimestamp_ = subBuilder.buildPartial();
}
+ break;
+ }
+ case 18:
+ {
+ com.google.spanner.v1.CommitResponse.CommitStats.Builder subBuilder = null;
+ if (commitStats_ != null) {
+ subBuilder = commitStats_.toBuilder();
+ }
+ commitStats_ =
+ input.readMessage(
+ com.google.spanner.v1.CommitResponse.CommitStats.parser(), extensionRegistry);
+ if (subBuilder != null) {
+ subBuilder.mergeFrom(commitStats_);
+ commitStats_ = subBuilder.buildPartial();
+ }
+
break;
}
default:
@@ -117,6 +133,586 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
com.google.spanner.v1.CommitResponse.Builder.class);
}
+ public interface CommitStatsOrBuilder
+ extends
+ // @@protoc_insertion_point(interface_extends:google.spanner.v1.CommitResponse.CommitStats)
+ com.google.protobuf.MessageOrBuilder {
+
+ /**
+ *
+ *
+ *
+ * The total number of mutations for the transaction. Knowing the
+ * `mutation_count` value can help you maximize the number of mutations
+ * in a transaction and minimize the number of API round trips. You can
+ * also monitor this value to prevent transactions from exceeding the system
+ * [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+ * If the number of mutations exceeds the limit, the server returns
+ * [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+ *
+ *
+ * int64 mutation_count = 1;
+ *
+ * @return The mutationCount.
+ */
+ long getMutationCount();
+ }
+ /**
+ *
+ *
+ *
+ * Additional statistics about a commit.
+ *
+ *
+ * Protobuf type {@code google.spanner.v1.CommitResponse.CommitStats}
+ */
+ public static final class CommitStats extends com.google.protobuf.GeneratedMessageV3
+ implements
+ // @@protoc_insertion_point(message_implements:google.spanner.v1.CommitResponse.CommitStats)
+ CommitStatsOrBuilder {
+ private static final long serialVersionUID = 0L;
+ // Use CommitStats.newBuilder() to construct.
+ private CommitStats(com.google.protobuf.GeneratedMessageV3.Builder builder) {
+ super(builder);
+ }
+
+ private CommitStats() {}
+
+ @java.lang.Override
+ @SuppressWarnings({"unused"})
+ protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
+ return new CommitStats();
+ }
+
+ @java.lang.Override
+ public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
+ return this.unknownFields;
+ }
+
+ private CommitStats(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ this();
+ if (extensionRegistry == null) {
+ throw new java.lang.NullPointerException();
+ }
+ com.google.protobuf.UnknownFieldSet.Builder unknownFields =
+ com.google.protobuf.UnknownFieldSet.newBuilder();
+ try {
+ boolean done = false;
+ while (!done) {
+ int tag = input.readTag();
+ switch (tag) {
+ case 0:
+ done = true;
+ break;
+ case 8:
+ {
+ mutationCount_ = input.readInt64();
+ break;
+ }
+ default:
+ {
+ if (!parseUnknownField(input, unknownFields, extensionRegistry, tag)) {
+ done = true;
+ }
+ break;
+ }
+ }
+ }
+ } catch (com.google.protobuf.InvalidProtocolBufferException e) {
+ throw e.setUnfinishedMessage(this);
+ } catch (java.io.IOException e) {
+ throw new com.google.protobuf.InvalidProtocolBufferException(e).setUnfinishedMessage(this);
+ } finally {
+ this.unknownFields = unknownFields.build();
+ makeExtensionsImmutable();
+ }
+ }
+
+ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
+ return com.google.spanner.v1.SpannerProto
+ .internal_static_google_spanner_v1_CommitResponse_CommitStats_descriptor;
+ }
+
+ @java.lang.Override
+ protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
+ internalGetFieldAccessorTable() {
+ return com.google.spanner.v1.SpannerProto
+ .internal_static_google_spanner_v1_CommitResponse_CommitStats_fieldAccessorTable
+ .ensureFieldAccessorsInitialized(
+ com.google.spanner.v1.CommitResponse.CommitStats.class,
+ com.google.spanner.v1.CommitResponse.CommitStats.Builder.class);
+ }
+
+ public static final int MUTATION_COUNT_FIELD_NUMBER = 1;
+ private long mutationCount_;
+ /**
+ *
+ *
+ *
+ * The total number of mutations for the transaction. Knowing the
+ * `mutation_count` value can help you maximize the number of mutations
+ * in a transaction and minimize the number of API round trips. You can
+ * also monitor this value to prevent transactions from exceeding the system
+ * [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+ * If the number of mutations exceeds the limit, the server returns
+ * [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+ *
+ *
+ * int64 mutation_count = 1;
+ *
+ * @return The mutationCount.
+ */
+ @java.lang.Override
+ public long getMutationCount() {
+ return mutationCount_;
+ }
+
+ private byte memoizedIsInitialized = -1;
+
+ @java.lang.Override
+ public final boolean isInitialized() {
+ byte isInitialized = memoizedIsInitialized;
+ if (isInitialized == 1) return true;
+ if (isInitialized == 0) return false;
+
+ memoizedIsInitialized = 1;
+ return true;
+ }
+
+ @java.lang.Override
+ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
+ if (mutationCount_ != 0L) {
+ output.writeInt64(1, mutationCount_);
+ }
+ unknownFields.writeTo(output);
+ }
+
+ @java.lang.Override
+ public int getSerializedSize() {
+ int size = memoizedSize;
+ if (size != -1) return size;
+
+ size = 0;
+ if (mutationCount_ != 0L) {
+ size += com.google.protobuf.CodedOutputStream.computeInt64Size(1, mutationCount_);
+ }
+ size += unknownFields.getSerializedSize();
+ memoizedSize = size;
+ return size;
+ }
+
+ @java.lang.Override
+ public boolean equals(final java.lang.Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof com.google.spanner.v1.CommitResponse.CommitStats)) {
+ return super.equals(obj);
+ }
+ com.google.spanner.v1.CommitResponse.CommitStats other =
+ (com.google.spanner.v1.CommitResponse.CommitStats) obj;
+
+ if (getMutationCount() != other.getMutationCount()) return false;
+ if (!unknownFields.equals(other.unknownFields)) return false;
+ return true;
+ }
+
+ @java.lang.Override
+ public int hashCode() {
+ if (memoizedHashCode != 0) {
+ return memoizedHashCode;
+ }
+ int hash = 41;
+ hash = (19 * hash) + getDescriptor().hashCode();
+ hash = (37 * hash) + MUTATION_COUNT_FIELD_NUMBER;
+ hash = (53 * hash) + com.google.protobuf.Internal.hashLong(getMutationCount());
+ hash = (29 * hash) + unknownFields.hashCode();
+ memoizedHashCode = hash;
+ return hash;
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ com.google.protobuf.ByteString data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(byte[] data)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws com.google.protobuf.InvalidProtocolBufferException {
+ return PARSER.parseFrom(data, extensionRegistry);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseDelimitedFrom(
+ java.io.InputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseDelimitedFrom(
+ java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ com.google.protobuf.CodedInputStream input) throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats parseFrom(
+ com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry)
+ throws java.io.IOException {
+ return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
+ PARSER, input, extensionRegistry);
+ }
+
+ @java.lang.Override
+ public Builder newBuilderForType() {
+ return newBuilder();
+ }
+
+ public static Builder newBuilder() {
+ return DEFAULT_INSTANCE.toBuilder();
+ }
+
+ public static Builder newBuilder(com.google.spanner.v1.CommitResponse.CommitStats prototype) {
+ return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
+ }
+
+ @java.lang.Override
+ public Builder toBuilder() {
+ return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
+ }
+
+ @java.lang.Override
+ protected Builder newBuilderForType(
+ com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
+ Builder builder = new Builder(parent);
+ return builder;
+ }
+ /**
+ *
+ *
+ *
+ * Additional statistics about a commit.
+ *
+ *
+ * Protobuf type {@code google.spanner.v1.CommitResponse.CommitStats}
+ */
+ public static final class Builder
+ extends com.google.protobuf.GeneratedMessageV3.Builder
+ * The total number of mutations for the transaction. Knowing the
+ * `mutation_count` value can help you maximize the number of mutations
+ * in a transaction and minimize the number of API round trips. You can
+ * also monitor this value to prevent transactions from exceeding the system
+ * [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+ * If the number of mutations exceeds the limit, the server returns
+ * [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+ *
+ *
+ * int64 mutation_count = 1;
+ *
+ * @return The mutationCount.
+ */
+ @java.lang.Override
+ public long getMutationCount() {
+ return mutationCount_;
+ }
+ /**
+ *
+ *
+ *
+ * The total number of mutations for the transaction. Knowing the
+ * `mutation_count` value can help you maximize the number of mutations
+ * in a transaction and minimize the number of API round trips. You can
+ * also monitor this value to prevent transactions from exceeding the system
+ * [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+ * If the number of mutations exceeds the limit, the server returns
+ * [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+ *
+ *
+ * int64 mutation_count = 1;
+ *
+ * @param value The mutationCount to set.
+ * @return This builder for chaining.
+ */
+ public Builder setMutationCount(long value) {
+
+ mutationCount_ = value;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The total number of mutations for the transaction. Knowing the
+ * `mutation_count` value can help you maximize the number of mutations
+ * in a transaction and minimize the number of API round trips. You can
+ * also monitor this value to prevent transactions from exceeding the system
+ * [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+ * If the number of mutations exceeds the limit, the server returns
+ * [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+ *
+ *
+ * int64 mutation_count = 1;
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearMutationCount() {
+
+ mutationCount_ = 0L;
+ onChanged();
+ return this;
+ }
+
+ @java.lang.Override
+ public final Builder setUnknownFields(
+ final com.google.protobuf.UnknownFieldSet unknownFields) {
+ return super.setUnknownFields(unknownFields);
+ }
+
+ @java.lang.Override
+ public final Builder mergeUnknownFields(
+ final com.google.protobuf.UnknownFieldSet unknownFields) {
+ return super.mergeUnknownFields(unknownFields);
+ }
+
+ // @@protoc_insertion_point(builder_scope:google.spanner.v1.CommitResponse.CommitStats)
+ }
+
+ // @@protoc_insertion_point(class_scope:google.spanner.v1.CommitResponse.CommitStats)
+ private static final com.google.spanner.v1.CommitResponse.CommitStats DEFAULT_INSTANCE;
+
+ static {
+ DEFAULT_INSTANCE = new com.google.spanner.v1.CommitResponse.CommitStats();
+ }
+
+ public static com.google.spanner.v1.CommitResponse.CommitStats getDefaultInstance() {
+ return DEFAULT_INSTANCE;
+ }
+
+ private static final com.google.protobuf.Parser
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ *
+ * @return Whether the commitStats field is set.
+ */
+ @java.lang.Override
+ public boolean hasCommitStats() {
+ return commitStats_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ *
+ * @return The commitStats.
+ */
+ @java.lang.Override
+ public com.google.spanner.v1.CommitResponse.CommitStats getCommitStats() {
+ return commitStats_ == null
+ ? com.google.spanner.v1.CommitResponse.CommitStats.getDefaultInstance()
+ : commitStats_;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ @java.lang.Override
+ public com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder getCommitStatsOrBuilder() {
+ return getCommitStats();
+ }
+
private byte memoizedIsInitialized = -1;
@java.lang.Override
@@ -182,6 +832,9 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (commitTimestamp_ != null) {
output.writeMessage(1, getCommitTimestamp());
}
+ if (commitStats_ != null) {
+ output.writeMessage(2, getCommitStats());
+ }
unknownFields.writeTo(output);
}
@@ -194,6 +847,9 @@ public int getSerializedSize() {
if (commitTimestamp_ != null) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(1, getCommitTimestamp());
}
+ if (commitStats_ != null) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(2, getCommitStats());
+ }
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
@@ -213,6 +869,10 @@ public boolean equals(final java.lang.Object obj) {
if (hasCommitTimestamp()) {
if (!getCommitTimestamp().equals(other.getCommitTimestamp())) return false;
}
+ if (hasCommitStats() != other.hasCommitStats()) return false;
+ if (hasCommitStats()) {
+ if (!getCommitStats().equals(other.getCommitStats())) return false;
+ }
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@@ -228,6 +888,10 @@ public int hashCode() {
hash = (37 * hash) + COMMIT_TIMESTAMP_FIELD_NUMBER;
hash = (53 * hash) + getCommitTimestamp().hashCode();
}
+ if (hasCommitStats()) {
+ hash = (37 * hash) + COMMIT_STATS_FIELD_NUMBER;
+ hash = (53 * hash) + getCommitStats().hashCode();
+ }
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
@@ -378,6 +1042,12 @@ public Builder clear() {
commitTimestamp_ = null;
commitTimestampBuilder_ = null;
}
+ if (commitStatsBuilder_ == null) {
+ commitStats_ = null;
+ } else {
+ commitStats_ = null;
+ commitStatsBuilder_ = null;
+ }
return this;
}
@@ -409,6 +1079,11 @@ public com.google.spanner.v1.CommitResponse buildPartial() {
} else {
result.commitTimestamp_ = commitTimestampBuilder_.build();
}
+ if (commitStatsBuilder_ == null) {
+ result.commitStats_ = commitStats_;
+ } else {
+ result.commitStats_ = commitStatsBuilder_.build();
+ }
onBuilt();
return result;
}
@@ -461,6 +1136,9 @@ public Builder mergeFrom(com.google.spanner.v1.CommitResponse other) {
if (other.hasCommitTimestamp()) {
mergeCommitTimestamp(other.getCommitTimestamp());
}
+ if (other.hasCommitStats()) {
+ mergeCommitStats(other.getCommitStats());
+ }
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
@@ -675,6 +1353,210 @@ public com.google.protobuf.TimestampOrBuilder getCommitTimestampOrBuilder() {
return commitTimestampBuilder_;
}
+ private com.google.spanner.v1.CommitResponse.CommitStats commitStats_;
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.spanner.v1.CommitResponse.CommitStats,
+ com.google.spanner.v1.CommitResponse.CommitStats.Builder,
+ com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder>
+ commitStatsBuilder_;
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ *
+ * @return Whether the commitStats field is set.
+ */
+ public boolean hasCommitStats() {
+ return commitStatsBuilder_ != null || commitStats_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ *
+ * @return The commitStats.
+ */
+ public com.google.spanner.v1.CommitResponse.CommitStats getCommitStats() {
+ if (commitStatsBuilder_ == null) {
+ return commitStats_ == null
+ ? com.google.spanner.v1.CommitResponse.CommitStats.getDefaultInstance()
+ : commitStats_;
+ } else {
+ return commitStatsBuilder_.getMessage();
+ }
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ public Builder setCommitStats(com.google.spanner.v1.CommitResponse.CommitStats value) {
+ if (commitStatsBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ commitStats_ = value;
+ onChanged();
+ } else {
+ commitStatsBuilder_.setMessage(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ public Builder setCommitStats(
+ com.google.spanner.v1.CommitResponse.CommitStats.Builder builderForValue) {
+ if (commitStatsBuilder_ == null) {
+ commitStats_ = builderForValue.build();
+ onChanged();
+ } else {
+ commitStatsBuilder_.setMessage(builderForValue.build());
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ public Builder mergeCommitStats(com.google.spanner.v1.CommitResponse.CommitStats value) {
+ if (commitStatsBuilder_ == null) {
+ if (commitStats_ != null) {
+ commitStats_ =
+ com.google.spanner.v1.CommitResponse.CommitStats.newBuilder(commitStats_)
+ .mergeFrom(value)
+ .buildPartial();
+ } else {
+ commitStats_ = value;
+ }
+ onChanged();
+ } else {
+ commitStatsBuilder_.mergeFrom(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ public Builder clearCommitStats() {
+ if (commitStatsBuilder_ == null) {
+ commitStats_ = null;
+ onChanged();
+ } else {
+ commitStats_ = null;
+ commitStatsBuilder_ = null;
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ public com.google.spanner.v1.CommitResponse.CommitStats.Builder getCommitStatsBuilder() {
+
+ onChanged();
+ return getCommitStatsFieldBuilder().getBuilder();
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ public com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder getCommitStatsOrBuilder() {
+ if (commitStatsBuilder_ != null) {
+ return commitStatsBuilder_.getMessageOrBuilder();
+ } else {
+ return commitStats_ == null
+ ? com.google.spanner.v1.CommitResponse.CommitStats.getDefaultInstance()
+ : commitStats_;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.spanner.v1.CommitResponse.CommitStats,
+ com.google.spanner.v1.CommitResponse.CommitStats.Builder,
+ com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder>
+ getCommitStatsFieldBuilder() {
+ if (commitStatsBuilder_ == null) {
+ commitStatsBuilder_ =
+ new com.google.protobuf.SingleFieldBuilderV3<
+ com.google.spanner.v1.CommitResponse.CommitStats,
+ com.google.spanner.v1.CommitResponse.CommitStats.Builder,
+ com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder>(
+ getCommitStats(), getParentForChildren(), isClean());
+ commitStats_ = null;
+ }
+ return commitStatsBuilder_;
+ }
+
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponseOrBuilder.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponseOrBuilder.java
index 90c6c6e6729..9ff076ff849 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponseOrBuilder.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitResponseOrBuilder.java
@@ -57,4 +57,45 @@ public interface CommitResponseOrBuilder
* .google.protobuf.Timestamp commit_timestamp = 1;
*/
com.google.protobuf.TimestampOrBuilder getCommitTimestampOrBuilder();
+
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ *
+ * @return Whether the commitStats field is set.
+ */
+ boolean hasCommitStats();
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ *
+ * @return The commitStats.
+ */
+ com.google.spanner.v1.CommitResponse.CommitStats getCommitStats();
+ /**
+ *
+ *
+ *
+ * The statistics about this Commit. Not returned by default.
+ * For more information, see
+ * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+ *
+ *
+ * .google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;
+ */
+ com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder getCommitStatsOrBuilder();
}
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequest.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequest.java
index 1e757805fd5..79a7ad822b4 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequest.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequest.java
@@ -402,6 +402,9 @@ public interface QueryOptionsOrBuilder
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -426,6 +429,9 @@ public interface QueryOptionsOrBuilder
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -546,6 +552,9 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -581,6 +590,9 @@ public java.lang.String getOptimizerVersion() {
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -941,6 +953,9 @@ public Builder mergeFrom(
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -975,6 +990,9 @@ public java.lang.String getOptimizerVersion() {
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -1009,6 +1027,9 @@ public com.google.protobuf.ByteString getOptimizerVersionBytes() {
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -1042,6 +1063,9 @@ public Builder setOptimizerVersion(java.lang.String value) {
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -1071,6 +1095,9 @@ public Builder clearOptimizerVersion() {
* SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
* with an invalid optimizer version will fail with a syntax error
* (`INVALID_ARGUMENT`) status.
+ * See
+ * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+ * for more information on managing the query optimizer.
* The `optimizer_version` statement hint has precedence over this setting.
*
*
@@ -1318,8 +1345,9 @@ public com.google.protobuf.ByteString getSqlBytes() {
*
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -1340,8 +1368,9 @@ public boolean hasParams() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -1362,8 +1391,9 @@ public com.google.protobuf.Struct getParams() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2656,8 +2686,9 @@ public Builder setSqlBytes(com.google.protobuf.ByteString value) {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2677,8 +2708,9 @@ public boolean hasParams() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2702,8 +2734,9 @@ public com.google.protobuf.Struct getParams() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2731,8 +2764,9 @@ public Builder setParams(com.google.protobuf.Struct value) {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2757,8 +2791,9 @@ public Builder setParams(com.google.protobuf.Struct.Builder builderForValue) {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2787,8 +2822,9 @@ public Builder mergeParams(com.google.protobuf.Struct value) {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2814,8 +2850,9 @@ public Builder clearParams() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2835,8 +2872,9 @@ public com.google.protobuf.Struct.Builder getParamsBuilder() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -2858,8 +2896,9 @@ public com.google.protobuf.StructOrBuilder getParamsOrBuilder() {
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequestOrBuilder.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequestOrBuilder.java
index 7971beeb49c..d6af9b0ba6c 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequestOrBuilder.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/ExecuteSqlRequestOrBuilder.java
@@ -136,8 +136,9 @@ public interface ExecuteSqlRequestOrBuilder
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -155,8 +156,9 @@ public interface ExecuteSqlRequestOrBuilder
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
@@ -174,8 +176,9 @@ public interface ExecuteSqlRequestOrBuilder
*
*
- *
* Parameter names and values that bind to placeholders in the SQL string.
* A parameter placeholder consists of the `@` character followed by the
- * parameter name (for example, `@firstName`). Parameter names can contain
- * letters, numbers, and underscores.
+ * parameter name (for example, `@firstName`). Parameter names must conform
+ * to the naming requirements of identifiers as specified at
+ * https://cloud.google.com/spanner/docs/lexical#identifiers.
* Parameters can appear anywhere that a literal value is expected. The same
* parameter name can be used more than once, for example:
* `"WHERE id > @msg_id AND id < @msg_id + 100"`
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/Session.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/Session.java
index 9fe4f10c7cb..1b058eb621f 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/Session.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/Session.java
@@ -170,11 +170,10 @@ protected com.google.protobuf.MapField internalGetMapField(int number) {
*
*
*
*
- *
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
@@ -194,11 +193,10 @@ public java.lang.String getName() {
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
@@ -346,7 +344,8 @@ public java.lang.String getLabelsOrThrow(java.lang.String key) {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return Whether the createTime field is set.
*/
@@ -361,7 +360,8 @@ public boolean hasCreateTime() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The createTime.
*/
@@ -376,7 +376,8 @@ public com.google.protobuf.Timestamp getCreateTime() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
@java.lang.Override
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
@@ -393,7 +394,9 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
* typically earlier than the actual last use time.
* .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return Whether the approximateLastUseTime field is set.
*/
@@ -409,7 +412,9 @@ public boolean hasApproximateLastUseTime() {
* typically earlier than the actual last use time.
* .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The approximateLastUseTime.
*/
@@ -427,7 +432,9 @@ public com.google.protobuf.Timestamp getApproximateLastUseTime() {
* typically earlier than the actual last use time.
* .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
@java.lang.Override
public com.google.protobuf.TimestampOrBuilder getApproximateLastUseTimeOrBuilder() {
@@ -852,11 +859,10 @@ public Builder mergeFrom(
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
@@ -875,11 +881,10 @@ public java.lang.String getName() {
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
@@ -898,11 +903,10 @@ public com.google.protobuf.ByteString getNameBytes() {
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @param value The name to set.
* @return This builder for chaining.
@@ -920,11 +924,10 @@ public Builder setName(java.lang.String value) {
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return This builder for chaining.
*/
@@ -938,11 +941,10 @@ public Builder clearName() {
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @param value The bytes for name to set.
* @return This builder for chaining.
@@ -1170,7 +1172,9 @@ public Builder putAllLabels(java.util.Map.google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return Whether the createTime field is set.
*/
@@ -1184,7 +1188,9 @@ public boolean hasCreateTime() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The createTime.
*/
@@ -1204,7 +1210,9 @@ public com.google.protobuf.Timestamp getCreateTime() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder setCreateTime(com.google.protobuf.Timestamp value) {
if (createTimeBuilder_ == null) {
@@ -1226,7 +1234,9 @@ public Builder setCreateTime(com.google.protobuf.Timestamp value) {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue) {
if (createTimeBuilder_ == null) {
@@ -1245,7 +1255,9 @@ public Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForVal
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder mergeCreateTime(com.google.protobuf.Timestamp value) {
if (createTimeBuilder_ == null) {
@@ -1269,7 +1281,9 @@ public Builder mergeCreateTime(com.google.protobuf.Timestamp value) {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder clearCreateTime() {
if (createTimeBuilder_ == null) {
@@ -1289,7 +1303,9 @@ public Builder clearCreateTime() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder() {
@@ -1303,7 +1319,9 @@ public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
if (createTimeBuilder_ != null) {
@@ -1321,7 +1339,9 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
* Output only. The timestamp when the session is created.
* .google.protobuf.Timestamp create_time = 3;
+ *
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp,
@@ -1354,7 +1374,9 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return Whether the approximateLastUseTime field is set.
*/
@@ -1369,7 +1391,9 @@ public boolean hasApproximateLastUseTime() {
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The approximateLastUseTime.
*/
@@ -1390,7 +1414,9 @@ public com.google.protobuf.Timestamp getApproximateLastUseTime() {
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder setApproximateLastUseTime(com.google.protobuf.Timestamp value) {
if (approximateLastUseTimeBuilder_ == null) {
@@ -1413,7 +1439,9 @@ public Builder setApproximateLastUseTime(com.google.protobuf.Timestamp value) {
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder setApproximateLastUseTime(
com.google.protobuf.Timestamp.Builder builderForValue) {
@@ -1434,7 +1462,9 @@ public Builder setApproximateLastUseTime(
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder mergeApproximateLastUseTime(com.google.protobuf.Timestamp value) {
if (approximateLastUseTimeBuilder_ == null) {
@@ -1461,7 +1491,9 @@ public Builder mergeApproximateLastUseTime(com.google.protobuf.Timestamp value)
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public Builder clearApproximateLastUseTime() {
if (approximateLastUseTimeBuilder_ == null) {
@@ -1482,7 +1514,9 @@ public Builder clearApproximateLastUseTime() {
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public com.google.protobuf.Timestamp.Builder getApproximateLastUseTimeBuilder() {
@@ -1497,7 +1531,9 @@ public com.google.protobuf.Timestamp.Builder getApproximateLastUseTimeBuilder()
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
public com.google.protobuf.TimestampOrBuilder getApproximateLastUseTimeOrBuilder() {
if (approximateLastUseTimeBuilder_ != null) {
@@ -1516,7 +1552,9 @@ public com.google.protobuf.TimestampOrBuilder getApproximateLastUseTimeOrBuilder
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp,
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SessionOrBuilder.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SessionOrBuilder.java
index 6b7fc5b822a..556832d0093 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SessionOrBuilder.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SessionOrBuilder.java
@@ -27,11 +27,10 @@ public interface SessionOrBuilder
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
@@ -40,11 +39,10 @@ public interface SessionOrBuilder
*
*
*
- * The name of the session. This is always system-assigned; values provided
- * when creating a session are ignored.
+ * Output only. The name of the session. This is always system-assigned.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
@@ -141,7 +139,8 @@ public interface SessionOrBuilder
* Output only. The timestamp when the session is created.
*
*
- * .google.protobuf.Timestamp create_time = 3;
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return Whether the createTime field is set.
*/
@@ -153,7 +152,8 @@ public interface SessionOrBuilder
* Output only. The timestamp when the session is created.
*
*
- * .google.protobuf.Timestamp create_time = 3;
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The createTime.
*/
@@ -165,7 +165,8 @@ public interface SessionOrBuilder
* Output only. The timestamp when the session is created.
*
*
- * .google.protobuf.Timestamp create_time = 3;
+ * .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
@@ -177,7 +178,9 @@ public interface SessionOrBuilder
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return Whether the approximateLastUseTime field is set.
*/
@@ -190,7 +193,9 @@ public interface SessionOrBuilder
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*
* @return The approximateLastUseTime.
*/
@@ -203,7 +208,9 @@ public interface SessionOrBuilder
* typically earlier than the actual last use time.
*
*
- * .google.protobuf.Timestamp approximate_last_use_time = 4;
+ *
+ * .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
*/
com.google.protobuf.TimestampOrBuilder getApproximateLastUseTimeOrBuilder();
}
diff --git a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SpannerProto.java b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SpannerProto.java
index 0932ab5d52a..8458063adac 100644
--- a/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SpannerProto.java
+++ b/proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SpannerProto.java
@@ -131,6 +131,10 @@ public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry r
internal_static_google_spanner_v1_CommitResponse_descriptor;
static final com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internal_static_google_spanner_v1_CommitResponse_fieldAccessorTable;
+ static final com.google.protobuf.Descriptors.Descriptor
+ internal_static_google_spanner_v1_CommitResponse_CommitStats_descriptor;
+ static final com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
+ internal_static_google_spanner_v1_CommitResponse_CommitStats_fieldAccessorTable;
static final com.google.protobuf.Descriptors.Descriptor
internal_static_google_spanner_v1_RollbackRequest_descriptor;
static final com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
@@ -148,198 +152,202 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "e.spanner.v1\032\034google/api/annotations.pro"
+ "to\032\027google/api/client.proto\032\037google/api/"
+ "field_behavior.proto\032\031google/api/resourc"
- + "e.proto\032\033google/protobuf/empty.proto\032\034go"
- + "ogle/protobuf/struct.proto\032\037google/proto"
- + "buf/timestamp.proto\032\027google/rpc/status.p"
- + "roto\032\034google/spanner/v1/keys.proto\032 goog"
- + "le/spanner/v1/mutation.proto\032\"google/spa"
- + "nner/v1/result_set.proto\032#google/spanner"
- + "/v1/transaction.proto\032\034google/spanner/v1"
- + "/type.proto\"~\n\024CreateSessionRequest\0229\n\010d"
- + "atabase\030\001 \001(\tB\'\340A\002\372A!\n\037spanner.googleapi"
- + "s.com/Database\022+\n\007session\030\002 \001(\0132\032.google"
- + ".spanner.v1.Session\"\251\001\n\032BatchCreateSessi"
- + "onsRequest\0229\n\010database\030\001 \001(\tB\'\340A\002\372A!\n\037sp"
- + "anner.googleapis.com/Database\0224\n\020session"
- + "_template\030\002 \001(\0132\032.google.spanner.v1.Sess"
- + "ion\022\032\n\rsession_count\030\003 \001(\005B\003\340A\002\"J\n\033Batch"
- + "CreateSessionsResponse\022+\n\007session\030\001 \003(\0132"
- + "\032.google.spanner.v1.Session\"\344\002\n\007Session\022"
- + "\014\n\004name\030\001 \001(\t\0226\n\006labels\030\002 \003(\0132&.google.s"
- + "panner.v1.Session.LabelsEntry\022/\n\013create_"
- + "time\030\003 \001(\0132\032.google.protobuf.Timestamp\022="
- + "\n\031approximate_last_use_time\030\004 \001(\0132\032.goog"
- + "le.protobuf.Timestamp\032-\n\013LabelsEntry\022\013\n\003"
- + "key\030\001 \001(\t\022\r\n\005value\030\002 \001(\t:\0028\001:t\352Aq\n\036spann"
- + "er.googleapis.com/Session\022Oprojects/{pro"
- + "ject}/instances/{instance}/databases/{da"
- + "tabase}/sessions/{session}\"I\n\021GetSession"
- + "Request\0224\n\004name\030\001 \001(\tB&\340A\002\372A \n\036spanner.g"
- + "oogleapis.com/Session\"\207\001\n\023ListSessionsRe"
- + "quest\0229\n\010database\030\001 \001(\tB\'\340A\002\372A!\n\037spanner"
- + ".googleapis.com/Database\022\021\n\tpage_size\030\002 "
- + "\001(\005\022\022\n\npage_token\030\003 \001(\t\022\016\n\006filter\030\004 \001(\t\""
- + "]\n\024ListSessionsResponse\022,\n\010sessions\030\001 \003("
- + "\0132\032.google.spanner.v1.Session\022\027\n\017next_pa"
- + "ge_token\030\002 \001(\t\"L\n\024DeleteSessionRequest\0224"
- + "\n\004name\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapis"
- + ".com/Session\"\202\005\n\021ExecuteSqlRequest\0227\n\007se"
- + "ssion\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapis."
- + "com/Session\022;\n\013transaction\030\002 \001(\0132&.googl"
- + "e.spanner.v1.TransactionSelector\022\020\n\003sql\030"
- + "\003 \001(\tB\003\340A\002\022\'\n\006params\030\004 \001(\0132\027.google.prot"
- + "obuf.Struct\022I\n\013param_types\030\005 \003(\01324.googl"
- + "e.spanner.v1.ExecuteSqlRequest.ParamType"
- + "sEntry\022\024\n\014resume_token\030\006 \001(\014\022B\n\nquery_mo"
- + "de\030\007 \001(\0162..google.spanner.v1.ExecuteSqlR"
- + "equest.QueryMode\022\027\n\017partition_token\030\010 \001("
- + "\014\022\r\n\005seqno\030\t \001(\003\022H\n\rquery_options\030\n \001(\0132"
- + "1.google.spanner.v1.ExecuteSqlRequest.Qu"
- + "eryOptions\032)\n\014QueryOptions\022\031\n\021optimizer_"
- + "version\030\001 \001(\t\032J\n\017ParamTypesEntry\022\013\n\003key\030"
- + "\001 \001(\t\022&\n\005value\030\002 \001(\0132\027.google.spanner.v1"
- + ".Type:\0028\001\".\n\tQueryMode\022\n\n\006NORMAL\020\000\022\010\n\004PL"
- + "AN\020\001\022\013\n\007PROFILE\020\002\"\337\003\n\026ExecuteBatchDmlReq"
- + "uest\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036spanner.g"
- + "oogleapis.com/Session\022@\n\013transaction\030\002 \001"
- + "(\0132&.google.spanner.v1.TransactionSelect"
- + "orB\003\340A\002\022L\n\nstatements\030\003 \003(\01323.google.spa"
- + "nner.v1.ExecuteBatchDmlRequest.Statement"
- + "B\003\340A\002\022\022\n\005seqno\030\004 \001(\003B\003\340A\002\032\347\001\n\tStatement\022"
- + "\013\n\003sql\030\001 \001(\t\022\'\n\006params\030\002 \001(\0132\027.google.pr"
- + "otobuf.Struct\022X\n\013param_types\030\003 \003(\0132C.goo"
+ + "e.proto\032\036google/protobuf/duration.proto\032"
+ + "\033google/protobuf/empty.proto\032\034google/pro"
+ + "tobuf/struct.proto\032\037google/protobuf/time"
+ + "stamp.proto\032\027google/rpc/status.proto\032\034go"
+ + "ogle/spanner/v1/keys.proto\032 google/spann"
+ + "er/v1/mutation.proto\032\"google/spanner/v1/"
+ + "result_set.proto\032#google/spanner/v1/tran"
+ + "saction.proto\032\034google/spanner/v1/type.pr"
+ + "oto\"~\n\024CreateSessionRequest\0229\n\010database\030"
+ + "\001 \001(\tB\'\340A\002\372A!\n\037spanner.googleapis.com/Da"
+ + "tabase\022+\n\007session\030\002 \001(\0132\032.google.spanner"
+ + ".v1.Session\"\251\001\n\032BatchCreateSessionsReque"
+ + "st\0229\n\010database\030\001 \001(\tB\'\340A\002\372A!\n\037spanner.go"
+ + "ogleapis.com/Database\0224\n\020session_templat"
+ + "e\030\002 \001(\0132\032.google.spanner.v1.Session\022\032\n\rs"
+ + "ession_count\030\003 \001(\005B\003\340A\002\"J\n\033BatchCreateSe"
+ + "ssionsResponse\022+\n\007session\030\001 \003(\0132\032.google"
+ + ".spanner.v1.Session\"\363\002\n\007Session\022\021\n\004name\030"
+ + "\001 \001(\tB\003\340A\003\0226\n\006labels\030\002 \003(\0132&.google.span"
+ + "ner.v1.Session.LabelsEntry\0224\n\013create_tim"
+ + "e\030\003 \001(\0132\032.google.protobuf.TimestampB\003\340A\003"
+ + "\022B\n\031approximate_last_use_time\030\004 \001(\0132\032.go"
+ + "ogle.protobuf.TimestampB\003\340A\003\032-\n\013LabelsEn"
+ + "try\022\013\n\003key\030\001 \001(\t\022\r\n\005value\030\002 \001(\t:\0028\001:t\352Aq"
+ + "\n\036spanner.googleapis.com/Session\022Oprojec"
+ + "ts/{project}/instances/{instance}/databa"
+ + "ses/{database}/sessions/{session}\"I\n\021Get"
+ + "SessionRequest\0224\n\004name\030\001 \001(\tB&\340A\002\372A \n\036sp"
+ + "anner.googleapis.com/Session\"\207\001\n\023ListSes"
+ + "sionsRequest\0229\n\010database\030\001 \001(\tB\'\340A\002\372A!\n\037"
+ + "spanner.googleapis.com/Database\022\021\n\tpage_"
+ + "size\030\002 \001(\005\022\022\n\npage_token\030\003 \001(\t\022\016\n\006filter"
+ + "\030\004 \001(\t\"]\n\024ListSessionsResponse\022,\n\010sessio"
+ + "ns\030\001 \003(\0132\032.google.spanner.v1.Session\022\027\n\017"
+ + "next_page_token\030\002 \001(\t\"L\n\024DeleteSessionRe"
+ + "quest\0224\n\004name\030\001 \001(\tB&\340A\002\372A \n\036spanner.goo"
+ + "gleapis.com/Session\"\202\005\n\021ExecuteSqlReques"
+ + "t\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036spanner.goog"
+ + "leapis.com/Session\022;\n\013transaction\030\002 \001(\0132"
+ + "&.google.spanner.v1.TransactionSelector\022"
+ + "\020\n\003sql\030\003 \001(\tB\003\340A\002\022\'\n\006params\030\004 \001(\0132\027.goog"
+ + "le.protobuf.Struct\022I\n\013param_types\030\005 \003(\0132"
+ + "4.google.spanner.v1.ExecuteSqlRequest.Pa"
+ + "ramTypesEntry\022\024\n\014resume_token\030\006 \001(\014\022B\n\nq"
+ + "uery_mode\030\007 \001(\0162..google.spanner.v1.Exec"
+ + "uteSqlRequest.QueryMode\022\027\n\017partition_tok"
+ + "en\030\010 \001(\014\022\r\n\005seqno\030\t \001(\003\022H\n\rquery_options"
+ + "\030\n \001(\01321.google.spanner.v1.ExecuteSqlReq"
+ + "uest.QueryOptions\032)\n\014QueryOptions\022\031\n\021opt"
+ + "imizer_version\030\001 \001(\t\032J\n\017ParamTypesEntry\022"
+ + "\013\n\003key\030\001 \001(\t\022&\n\005value\030\002 \001(\0132\027.google.spa"
+ + "nner.v1.Type:\0028\001\".\n\tQueryMode\022\n\n\006NORMAL\020"
+ + "\000\022\010\n\004PLAN\020\001\022\013\n\007PROFILE\020\002\"\337\003\n\026ExecuteBatc"
+ + "hDmlRequest\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036sp"
+ + "anner.googleapis.com/Session\022@\n\013transact"
+ + "ion\030\002 \001(\0132&.google.spanner.v1.Transactio"
+ + "nSelectorB\003\340A\002\022L\n\nstatements\030\003 \003(\01323.goo"
+ "gle.spanner.v1.ExecuteBatchDmlRequest.St"
- + "atement.ParamTypesEntry\032J\n\017ParamTypesEnt"
- + "ry\022\013\n\003key\030\001 \001(\t\022&\n\005value\030\002 \001(\0132\027.google."
- + "spanner.v1.Type:\0028\001\"p\n\027ExecuteBatchDmlRe"
- + "sponse\0221\n\013result_sets\030\001 \003(\0132\034.google.spa"
- + "nner.v1.ResultSet\022\"\n\006status\030\002 \001(\0132\022.goog"
- + "le.rpc.Status\"H\n\020PartitionOptions\022\034\n\024par"
- + "tition_size_bytes\030\001 \001(\003\022\026\n\016max_partition"
- + "s\030\002 \001(\003\"\243\003\n\025PartitionQueryRequest\0227\n\007ses"
- + "sion\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapis.c"
- + "om/Session\022;\n\013transaction\030\002 \001(\0132&.google"
- + ".spanner.v1.TransactionSelector\022\020\n\003sql\030\003"
- + " \001(\tB\003\340A\002\022\'\n\006params\030\004 \001(\0132\027.google.proto"
- + "buf.Struct\022M\n\013param_types\030\005 \003(\01328.google"
- + ".spanner.v1.PartitionQueryRequest.ParamT"
- + "ypesEntry\022>\n\021partition_options\030\006 \001(\0132#.g"
- + "oogle.spanner.v1.PartitionOptions\032J\n\017Par"
- + "amTypesEntry\022\013\n\003key\030\001 \001(\t\022&\n\005value\030\002 \001(\013"
- + "2\027.google.spanner.v1.Type:\0028\001\"\261\002\n\024Partit"
- + "ionReadRequest\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n"
- + "\036spanner.googleapis.com/Session\022;\n\013trans"
- + "action\030\002 \001(\0132&.google.spanner.v1.Transac"
- + "tionSelector\022\022\n\005table\030\003 \001(\tB\003\340A\002\022\r\n\005inde"
- + "x\030\004 \001(\t\022\017\n\007columns\030\005 \003(\t\022/\n\007key_set\030\006 \001("
- + "\0132\031.google.spanner.v1.KeySetB\003\340A\002\022>\n\021par"
- + "tition_options\030\t \001(\0132#.google.spanner.v1"
- + ".PartitionOptions\"$\n\tPartition\022\027\n\017partit"
- + "ion_token\030\001 \001(\014\"z\n\021PartitionResponse\0220\n\n"
- + "partitions\030\001 \003(\0132\034.google.spanner.v1.Par"
- + "tition\0223\n\013transaction\030\002 \001(\0132\036.google.spa"
- + "nner.v1.Transaction\"\253\002\n\013ReadRequest\0227\n\007s"
- + "ession\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapis"
- + ".com/Session\022;\n\013transaction\030\002 \001(\0132&.goog"
- + "le.spanner.v1.TransactionSelector\022\022\n\005tab"
- + "le\030\003 \001(\tB\003\340A\002\022\r\n\005index\030\004 \001(\t\022\024\n\007columns\030"
- + "\005 \003(\tB\003\340A\002\022/\n\007key_set\030\006 \001(\0132\031.google.spa"
- + "nner.v1.KeySetB\003\340A\002\022\r\n\005limit\030\010 \001(\003\022\024\n\014re"
- + "sume_token\030\t \001(\014\022\027\n\017partition_token\030\n \001("
- + "\014\"\217\001\n\027BeginTransactionRequest\0227\n\007session"
- + "\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapis.com/S"
- + "ession\022;\n\007options\030\002 \001(\0132%.google.spanner"
- + ".v1.TransactionOptionsB\003\340A\002\"\352\001\n\rCommitRe"
- + "quest\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036spanner."
- + "googleapis.com/Session\022\030\n\016transaction_id"
- + "\030\002 \001(\014H\000\022G\n\026single_use_transaction\030\003 \001(\013"
- + "2%.google.spanner.v1.TransactionOptionsH"
- + "\000\022.\n\tmutations\030\004 \003(\0132\033.google.spanner.v1"
- + ".MutationB\r\n\013transaction\"F\n\016CommitRespon"
- + "se\0224\n\020commit_timestamp\030\001 \001(\0132\032.google.pr"
- + "otobuf.Timestamp\"g\n\017RollbackRequest\0227\n\007s"
- + "ession\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapis"
- + ".com/Session\022\033\n\016transaction_id\030\002 \001(\014B\003\340A"
- + "\0022\300\026\n\007Spanner\022\246\001\n\rCreateSession\022\'.google"
- + ".spanner.v1.CreateSessionRequest\032\032.googl"
- + "e.spanner.v1.Session\"P\202\323\344\223\002?\":/v1/{datab"
- + "ase=projects/*/instances/*/databases/*}/"
- + "sessions:\001*\332A\010database\022\340\001\n\023BatchCreateSe"
- + "ssions\022-.google.spanner.v1.BatchCreateSe"
- + "ssionsRequest\032..google.spanner.v1.BatchC"
- + "reateSessionsResponse\"j\202\323\344\223\002K\"F/v1/{data"
- + "base=projects/*/instances/*/databases/*}"
- + "/sessions:batchCreate:\001*\332A\026database,sess"
- + "ion_count\022\227\001\n\nGetSession\022$.google.spanne"
- + "r.v1.GetSessionRequest\032\032.google.spanner."
- + "v1.Session\"G\202\323\344\223\002:\0228/v1/{name=projects/*"
- + "/instances/*/databases/*/sessions/*}\332A\004n"
- + "ame\022\256\001\n\014ListSessions\022&.google.spanner.v1"
- + ".ListSessionsRequest\032\'.google.spanner.v1"
- + ".ListSessionsResponse\"M\202\323\344\223\002<\022:/v1/{data"
- + "base=projects/*/instances/*/databases/*}"
- + "/sessions\332A\010database\022\231\001\n\rDeleteSession\022\'"
- + ".google.spanner.v1.DeleteSessionRequest\032"
- + "\026.google.protobuf.Empty\"G\202\323\344\223\002:*8/v1/{na"
- + "me=projects/*/instances/*/databases/*/se"
- + "ssions/*}\332A\004name\022\243\001\n\nExecuteSql\022$.google"
- + ".spanner.v1.ExecuteSqlRequest\032\034.google.s"
- + "panner.v1.ResultSet\"Q\202\323\344\223\002K\"F/v1/{sessio"
- + "n=projects/*/instances/*/databases/*/ses"
- + "sions/*}:executeSql:\001*\022\276\001\n\023ExecuteStream"
- + "ingSql\022$.google.spanner.v1.ExecuteSqlReq"
- + "uest\032#.google.spanner.v1.PartialResultSe"
- + "t\"Z\202\323\344\223\002T\"O/v1/{session=projects/*/insta"
- + "nces/*/databases/*/sessions/*}:executeSt"
- + "reamingSql:\001*0\001\022\300\001\n\017ExecuteBatchDml\022).go"
- + "ogle.spanner.v1.ExecuteBatchDmlRequest\032*"
- + ".google.spanner.v1.ExecuteBatchDmlRespon"
- + "se\"V\202\323\344\223\002P\"K/v1/{session=projects/*/inst"
- + "ances/*/databases/*/sessions/*}:executeB"
- + "atchDml:\001*\022\221\001\n\004Read\022\036.google.spanner.v1."
- + "ReadRequest\032\034.google.spanner.v1.ResultSe"
- + "t\"K\202\323\344\223\002E\"@/v1/{session=projects/*/insta"
- + "nces/*/databases/*/sessions/*}:read:\001*\022\254"
- + "\001\n\rStreamingRead\022\036.google.spanner.v1.Rea"
- + "dRequest\032#.google.spanner.v1.PartialResu"
- + "ltSet\"T\202\323\344\223\002N\"I/v1/{session=projects/*/i"
- + "nstances/*/databases/*/sessions/*}:strea"
- + "mingRead:\001*0\001\022\311\001\n\020BeginTransaction\022*.goo"
- + "gle.spanner.v1.BeginTransactionRequest\032\036"
- + ".google.spanner.v1.Transaction\"i\202\323\344\223\002Q\"L"
+ + "atementB\003\340A\002\022\022\n\005seqno\030\004 \001(\003B\003\340A\002\032\347\001\n\tSta"
+ + "tement\022\013\n\003sql\030\001 \001(\t\022\'\n\006params\030\002 \001(\0132\027.go"
+ + "ogle.protobuf.Struct\022X\n\013param_types\030\003 \003("
+ + "\0132C.google.spanner.v1.ExecuteBatchDmlReq"
+ + "uest.Statement.ParamTypesEntry\032J\n\017ParamT"
+ + "ypesEntry\022\013\n\003key\030\001 \001(\t\022&\n\005value\030\002 \001(\0132\027."
+ + "google.spanner.v1.Type:\0028\001\"p\n\027ExecuteBat"
+ + "chDmlResponse\0221\n\013result_sets\030\001 \003(\0132\034.goo"
+ + "gle.spanner.v1.ResultSet\022\"\n\006status\030\002 \001(\013"
+ + "2\022.google.rpc.Status\"H\n\020PartitionOptions"
+ + "\022\034\n\024partition_size_bytes\030\001 \001(\003\022\026\n\016max_pa"
+ + "rtitions\030\002 \001(\003\"\243\003\n\025PartitionQueryRequest"
+ + "\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036spanner.googl"
+ + "eapis.com/Session\022;\n\013transaction\030\002 \001(\0132&"
+ + ".google.spanner.v1.TransactionSelector\022\020"
+ + "\n\003sql\030\003 \001(\tB\003\340A\002\022\'\n\006params\030\004 \001(\0132\027.googl"
+ + "e.protobuf.Struct\022M\n\013param_types\030\005 \003(\01328"
+ + ".google.spanner.v1.PartitionQueryRequest"
+ + ".ParamTypesEntry\022>\n\021partition_options\030\006 "
+ + "\001(\0132#.google.spanner.v1.PartitionOptions"
+ + "\032J\n\017ParamTypesEntry\022\013\n\003key\030\001 \001(\t\022&\n\005valu"
+ + "e\030\002 \001(\0132\027.google.spanner.v1.Type:\0028\001\"\261\002\n"
+ + "\024PartitionReadRequest\0227\n\007session\030\001 \001(\tB&"
+ + "\340A\002\372A \n\036spanner.googleapis.com/Session\022;"
+ + "\n\013transaction\030\002 \001(\0132&.google.spanner.v1."
+ + "TransactionSelector\022\022\n\005table\030\003 \001(\tB\003\340A\002\022"
+ + "\r\n\005index\030\004 \001(\t\022\017\n\007columns\030\005 \003(\t\022/\n\007key_s"
+ + "et\030\006 \001(\0132\031.google.spanner.v1.KeySetB\003\340A\002"
+ + "\022>\n\021partition_options\030\t \001(\0132#.google.spa"
+ + "nner.v1.PartitionOptions\"$\n\tPartition\022\027\n"
+ + "\017partition_token\030\001 \001(\014\"z\n\021PartitionRespo"
+ + "nse\0220\n\npartitions\030\001 \003(\0132\034.google.spanner"
+ + ".v1.Partition\0223\n\013transaction\030\002 \001(\0132\036.goo"
+ + "gle.spanner.v1.Transaction\"\253\002\n\013ReadReque"
+ + "st\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036spanner.goo"
+ + "gleapis.com/Session\022;\n\013transaction\030\002 \001(\013"
+ + "2&.google.spanner.v1.TransactionSelector"
+ + "\022\022\n\005table\030\003 \001(\tB\003\340A\002\022\r\n\005index\030\004 \001(\t\022\024\n\007c"
+ + "olumns\030\005 \003(\tB\003\340A\002\022/\n\007key_set\030\006 \001(\0132\031.goo"
+ + "gle.spanner.v1.KeySetB\003\340A\002\022\r\n\005limit\030\010 \001("
+ + "\003\022\024\n\014resume_token\030\t \001(\014\022\027\n\017partition_tok"
+ + "en\030\n \001(\014\"\217\001\n\027BeginTransactionRequest\0227\n\007"
+ + "session\030\001 \001(\tB&\340A\002\372A \n\036spanner.googleapi"
+ + "s.com/Session\022;\n\007options\030\002 \001(\0132%.google."
+ + "spanner.v1.TransactionOptionsB\003\340A\002\"\207\002\n\rC"
+ + "ommitRequest\0227\n\007session\030\001 \001(\tB&\340A\002\372A \n\036s"
+ + "panner.googleapis.com/Session\022\030\n\016transac"
+ + "tion_id\030\002 \001(\014H\000\022G\n\026single_use_transactio"
+ + "n\030\003 \001(\0132%.google.spanner.v1.TransactionO"
+ + "ptionsH\000\022.\n\tmutations\030\004 \003(\0132\033.google.spa"
+ + "nner.v1.Mutation\022\033\n\023return_commit_stats\030"
+ + "\005 \001(\010B\r\n\013transaction\"\262\001\n\016CommitResponse\022"
+ + "4\n\020commit_timestamp\030\001 \001(\0132\032.google.proto"
+ + "buf.Timestamp\022C\n\014commit_stats\030\002 \001(\0132-.go"
+ + "ogle.spanner.v1.CommitResponse.CommitSta"
+ + "ts\032%\n\013CommitStats\022\026\n\016mutation_count\030\001 \001("
+ + "\003\"g\n\017RollbackRequest\0227\n\007session\030\001 \001(\tB&\340"
+ + "A\002\372A \n\036spanner.googleapis.com/Session\022\033\n"
+ + "\016transaction_id\030\002 \001(\014B\003\340A\0022\300\026\n\007Spanner\022\246"
+ + "\001\n\rCreateSession\022\'.google.spanner.v1.Cre"
+ + "ateSessionRequest\032\032.google.spanner.v1.Se"
+ + "ssion\"P\202\323\344\223\002?\":/v1/{database=projects/*/"
+ + "instances/*/databases/*}/sessions:\001*\332A\010d"
+ + "atabase\022\340\001\n\023BatchCreateSessions\022-.google"
+ + ".spanner.v1.BatchCreateSessionsRequest\032."
+ + ".google.spanner.v1.BatchCreateSessionsRe"
+ + "sponse\"j\202\323\344\223\002K\"F/v1/{database=projects/*"
+ + "/instances/*/databases/*}/sessions:batch"
+ + "Create:\001*\332A\026database,session_count\022\227\001\n\nG"
+ + "etSession\022$.google.spanner.v1.GetSession"
+ + "Request\032\032.google.spanner.v1.Session\"G\202\323\344"
+ + "\223\002:\0228/v1/{name=projects/*/instances/*/da"
+ + "tabases/*/sessions/*}\332A\004name\022\256\001\n\014ListSes"
+ + "sions\022&.google.spanner.v1.ListSessionsRe"
+ + "quest\032\'.google.spanner.v1.ListSessionsRe"
+ + "sponse\"M\202\323\344\223\002<\022:/v1/{database=projects/*"
+ + "/instances/*/databases/*}/sessions\332A\010dat"
+ + "abase\022\231\001\n\rDeleteSession\022\'.google.spanner"
+ + ".v1.DeleteSessionRequest\032\026.google.protob"
+ + "uf.Empty\"G\202\323\344\223\002:*8/v1/{name=projects/*/i"
+ + "nstances/*/databases/*/sessions/*}\332A\004nam"
+ + "e\022\243\001\n\nExecuteSql\022$.google.spanner.v1.Exe"
+ + "cuteSqlRequest\032\034.google.spanner.v1.Resul"
+ + "tSet\"Q\202\323\344\223\002K\"F/v1/{session=projects/*/in"
+ + "stances/*/databases/*/sessions/*}:execut"
+ + "eSql:\001*\022\276\001\n\023ExecuteStreamingSql\022$.google"
+ + ".spanner.v1.ExecuteSqlRequest\032#.google.s"
+ + "panner.v1.PartialResultSet\"Z\202\323\344\223\002T\"O/v1/"
+ + "{session=projects/*/instances/*/database"
+ + "s/*/sessions/*}:executeStreamingSql:\001*0\001"
+ + "\022\300\001\n\017ExecuteBatchDml\022).google.spanner.v1"
+ + ".ExecuteBatchDmlRequest\032*.google.spanner"
+ + ".v1.ExecuteBatchDmlResponse\"V\202\323\344\223\002P\"K/v1"
+ + "/{session=projects/*/instances/*/databas"
+ + "es/*/sessions/*}:executeBatchDml:\001*\022\221\001\n\004"
+ + "Read\022\036.google.spanner.v1.ReadRequest\032\034.g"
+ + "oogle.spanner.v1.ResultSet\"K\202\323\344\223\002E\"@/v1/"
+ + "{session=projects/*/instances/*/database"
+ + "s/*/sessions/*}:read:\001*\022\254\001\n\rStreamingRea"
+ + "d\022\036.google.spanner.v1.ReadRequest\032#.goog"
+ + "le.spanner.v1.PartialResultSet\"T\202\323\344\223\002N\"I"
+ "/v1/{session=projects/*/instances/*/data"
- + "bases/*/sessions/*}:beginTransaction:\001*\332"
- + "A\017session,options\022\353\001\n\006Commit\022 .google.sp"
- + "anner.v1.CommitRequest\032!.google.spanner."
- + "v1.CommitResponse\"\233\001\202\323\344\223\002G\"B/v1/{session"
- + "=projects/*/instances/*/databases/*/sess"
- + "ions/*}:commit:\001*\332A session,transaction_"
- + "id,mutations\332A(session,single_use_transa"
- + "ction,mutations\022\260\001\n\010Rollback\022\".google.sp"
- + "anner.v1.RollbackRequest\032\026.google.protob"
- + "uf.Empty\"h\202\323\344\223\002I\"D/v1/{session=projects/"
- + "*/instances/*/databases/*/sessions/*}:ro"
- + "llback:\001*\332A\026session,transaction_id\022\267\001\n\016P"
- + "artitionQuery\022(.google.spanner.v1.Partit"
- + "ionQueryRequest\032$.google.spanner.v1.Part"
- + "itionResponse\"U\202\323\344\223\002O\"J/v1/{session=proj"
- + "ects/*/instances/*/databases/*/sessions/"
- + "*}:partitionQuery:\001*\022\264\001\n\rPartitionRead\022\'"
- + ".google.spanner.v1.PartitionReadRequest\032"
- + "$.google.spanner.v1.PartitionResponse\"T\202"
- + "\323\344\223\002N\"I/v1/{session=projects/*/instances"
- + "/*/databases/*/sessions/*}:partitionRead"
- + ":\001*\032w\312A\026spanner.googleapis.com\322A[https:/"
- + "/www.googleapis.com/auth/cloud-platform,"
- + "https://www.googleapis.com/auth/spanner."
- + "dataB\224\002\n\025com.google.spanner.v1B\014SpannerP"
- + "rotoP\001Z8google.golang.org/genproto/googl"
- + "eapis/spanner/v1;spanner\252\002\027Google.Cloud."
- + "Spanner.V1\312\002\027Google\\Cloud\\Spanner\\V1\352\002\032G"
- + "oogle::Cloud::Spanner::V1\352A_\n\037spanner.go"
- + "ogleapis.com/Database\022
* # Transactions
- * Each session can have at most one active transaction at a time. After the
- * active transaction is completed, the session can immediately be
- * re-used for the next transaction. It is not necessary to create a
- * new session for each transaction.
+ * Each session can have at most one active transaction at a time (note that
+ * standalone reads and queries use a transaction internally and do count
+ * towards the one transaction limit). After the active transaction is
+ * completed, the session can immediately be re-used for the next transaction.
+ * It is not necessary to create a new session for each transaction.
* # Transaction Modes
* Cloud Spanner supports three transaction modes:
* 1. Locking read-write. This type of transaction is the only way
@@ -4312,10 +4313,11 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* # Transactions
- * Each session can have at most one active transaction at a time. After the
- * active transaction is completed, the session can immediately be
- * re-used for the next transaction. It is not necessary to create a
- * new session for each transaction.
+ * Each session can have at most one active transaction at a time (note that
+ * standalone reads and queries use a transaction internally and do count
+ * towards the one transaction limit). After the active transaction is
+ * completed, the session can immediately be re-used for the next transaction.
+ * It is not necessary to create a new session for each transaction.
* # Transaction Modes
* Cloud Spanner supports three transaction modes:
* 1. Locking read-write. This type of transaction is the only way
diff --git a/proto-google-cloud-spanner-v1/src/main/proto/google/spanner/v1/spanner.proto b/proto-google-cloud-spanner-v1/src/main/proto/google/spanner/v1/spanner.proto
index 93e4987ed16..8f579e333d3 100644
--- a/proto-google-cloud-spanner-v1/src/main/proto/google/spanner/v1/spanner.proto
+++ b/proto-google-cloud-spanner-v1/src/main/proto/google/spanner/v1/spanner.proto
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
@@ -219,6 +220,12 @@ service Spanner {
// transactions. However, it can also happen for a variety of other
// reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
// the transaction from the beginning, re-using the same session.
+ //
+ // On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
+ // for example, if the client job experiences a 1+ hour networking failure.
+ // At that point, Cloud Spanner has lost track of the transaction outcome and
+ // we recommend that you perform another read from the database to see the
+ // state of things as they are now.
rpc Commit(CommitRequest) returns (CommitResponse) {
option (google.api.http) = {
post: "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:commit"
@@ -331,9 +338,8 @@ message Session {
pattern: "projects/{project}/instances/{instance}/databases/{database}/sessions/{session}"
};
- // The name of the session. This is always system-assigned; values provided
- // when creating a session are ignored.
- string name = 1;
+ // Output only. The name of the session. This is always system-assigned.
+ string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// The labels for the session.
//
@@ -347,11 +353,11 @@ message Session {
mapgoogleapis/java-shared-config
### [`v0.10.0`](https://togithub.com/googleapis/java-shared-config/blob/master/CHANGELOG.md#0100-httpswwwgithubcomgoogleapisjava-shared-configcomparev094v0100-2021-01-21)
[Compare Source](https://togithub.com/googleapis/java-shared-config/compare/v0.9.4...v0.10.0)
##### Features
- adding pom profile to generate docfx yml from javadoc ([#213](https://www.github.com/googleapis/java-shared-config/issues/213)) ([3527c47](https://www.github.com/googleapis/java-shared-config/commit/3527c47ff413d415f87fccca84358da2c837841d))
##### Dependencies
- update dependency com.puppycrawl.tools:checkstyle to v8.39 ([#209](https://www.github.com/googleapis/java-shared-config/issues/209)) ([fb53922](https://www.github.com/googleapis/java-shared-config/commit/fb539226d407001822a56c7fff792922cd85d1fe))
##### [0.9.4](https://www.github.com/googleapis/java-shared-config/compare/v0.9.3...v0.9.4) (2020-10-21)
##### Documentation
- Latest for Cloud-RAD ([#199](https://www.github.com/googleapis/java-shared-config/issues/199)) ([34712af](https://www.github.com/googleapis/java-shared-config/commit/34712afac58aa0d148f0843026b3ff770ee030c2))
##### [0.9.3](https://www.github.com/googleapis/java-shared-config/compare/v0.9.2...v0.9.3) (2020-10-15)
##### Dependencies
- update auto-value-annotation.version to v1.7.4 ([#157](https://www.github.com/googleapis/java-shared-config/issues/157)) ([5d7e394](https://www.github.com/googleapis/java-shared-config/commit/5d7e394d964010a3e32af492cec4be85aabc3ebf))
##### [0.9.2](https://www.github.com/googleapis/java-shared-config/compare/v0.9.1...v0.9.2) (2020-07-02)
##### Dependencies
- update dependency org.apache.maven.surefire:surefire-junit47 to v3.0.0-M5 ([#180](https://www.github.com/googleapis/java-shared-config/issues/180)) ([802d9c5](https://www.github.com/googleapis/java-shared-config/commit/802d9c528d34b386face69ca75a014ce57fc3ac1))
##### [0.9.1](https://www.github.com/googleapis/java-shared-config/compare/v0.9.0...v0.9.1) (2020-07-01)
##### Bug Fixes
- maven-dependency-plugin configuration breaking downstream config ([#174](https://www.github.com/googleapis/java-shared-config/issues/174)) ([507217f](https://www.github.com/googleapis/java-shared-config/commit/507217fe509cd4f16eb50c8075ab43229238e08d))
##### Documentation
- change Devsite output path to /java/docs/reference ([#176](https://www.github.com/googleapis/java-shared-config/issues/176)) ([8b98af5](https://www.github.com/googleapis/java-shared-config/commit/8b98af54bf503d97bb86b6d02a5c4301b39384e1))
+ * The backup will contain an externally consistent copy of the database at + * the timestamp specified by `version_time`. If `version_time` is not + * specified, the system will set `version_time` to the `create_time` of the + * backup. + *+ * + *
.google.protobuf.Timestamp version_time = 9;
+ *
+ * @return Whether the versionTime field is set.
+ */
+ @java.lang.Override
+ public boolean hasVersionTime() {
+ return versionTime_ != null;
+ }
+ /**
+ *
+ *
+ * + * The backup will contain an externally consistent copy of the database at + * the timestamp specified by `version_time`. If `version_time` is not + * specified, the system will set `version_time` to the `create_time` of the + * backup. + *+ * + *
.google.protobuf.Timestamp version_time = 9;
+ *
+ * @return The versionTime.
+ */
+ @java.lang.Override
+ public com.google.protobuf.Timestamp getVersionTime() {
+ return versionTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : versionTime_;
+ }
+ /**
+ *
+ *
+ * + * The backup will contain an externally consistent copy of the database at + * the timestamp specified by `version_time`. If `version_time` is not + * specified, the system will set `version_time` to the `create_time` of the + * backup. + *+ * + *
.google.protobuf.Timestamp version_time = 9;
+ */
+ @java.lang.Override
+ public com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder() {
+ return getVersionTime();
+ }
+
public static final int EXPIRE_TIME_FIELD_NUMBER = 3;
private com.google.protobuf.Timestamp expireTime_;
/**
@@ -529,10 +599,9 @@ public com.google.protobuf.ByteString getNameBytes() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
@@ -548,10 +617,9 @@ public boolean hasCreateTime() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
@@ -567,10 +635,9 @@ public com.google.protobuf.Timestamp getCreateTime() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
@@ -764,6 +831,9 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
com.google.protobuf.GeneratedMessageV3.writeString(
output, 7, referencingDatabases_.getRaw(i));
}
+ if (versionTime_ != null) {
+ output.writeMessage(9, getVersionTime());
+ }
unknownFields.writeTo(output);
}
@@ -799,6 +869,9 @@ public int getSerializedSize() {
size += dataSize;
size += 1 * getReferencingDatabasesList().size();
}
+ if (versionTime_ != null) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(9, getVersionTime());
+ }
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
@@ -816,6 +889,10 @@ public boolean equals(final java.lang.Object obj) {
(com.google.spanner.admin.database.v1.Backup) obj;
if (!getDatabase().equals(other.getDatabase())) return false;
+ if (hasVersionTime() != other.hasVersionTime()) return false;
+ if (hasVersionTime()) {
+ if (!getVersionTime().equals(other.getVersionTime())) return false;
+ }
if (hasExpireTime() != other.hasExpireTime()) return false;
if (hasExpireTime()) {
if (!getExpireTime().equals(other.getExpireTime())) return false;
@@ -841,6 +918,10 @@ public int hashCode() {
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + DATABASE_FIELD_NUMBER;
hash = (53 * hash) + getDatabase().hashCode();
+ if (hasVersionTime()) {
+ hash = (37 * hash) + VERSION_TIME_FIELD_NUMBER;
+ hash = (53 * hash) + getVersionTime().hashCode();
+ }
if (hasExpireTime()) {
hash = (37 * hash) + EXPIRE_TIME_FIELD_NUMBER;
hash = (53 * hash) + getExpireTime().hashCode();
@@ -1006,6 +1087,12 @@ public Builder clear() {
super.clear();
database_ = "";
+ if (versionTimeBuilder_ == null) {
+ versionTime_ = null;
+ } else {
+ versionTime_ = null;
+ versionTimeBuilder_ = null;
+ }
if (expireTimeBuilder_ == null) {
expireTime_ = null;
} else {
@@ -1055,6 +1142,11 @@ public com.google.spanner.admin.database.v1.Backup buildPartial() {
new com.google.spanner.admin.database.v1.Backup(this);
int from_bitField0_ = bitField0_;
result.database_ = database_;
+ if (versionTimeBuilder_ == null) {
+ result.versionTime_ = versionTime_;
+ } else {
+ result.versionTime_ = versionTimeBuilder_.build();
+ }
if (expireTimeBuilder_ == null) {
result.expireTime_ = expireTime_;
} else {
@@ -1126,6 +1218,9 @@ public Builder mergeFrom(com.google.spanner.admin.database.v1.Backup other) {
database_ = other.database_;
onChanged();
}
+ if (other.hasVersionTime()) {
+ mergeVersionTime(other.getVersionTime());
+ }
if (other.hasExpireTime()) {
mergeExpireTime(other.getExpireTime());
}
@@ -1309,6 +1404,218 @@ public Builder setDatabaseBytes(com.google.protobuf.ByteString value) {
return this;
}
+ private com.google.protobuf.Timestamp versionTime_;
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>
+ versionTimeBuilder_;
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ *
+ * @return Whether the versionTime field is set.
+ */
+ public boolean hasVersionTime() {
+ return versionTimeBuilder_ != null || versionTime_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ *
+ * @return The versionTime.
+ */
+ public com.google.protobuf.Timestamp getVersionTime() {
+ if (versionTimeBuilder_ == null) {
+ return versionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : versionTime_;
+ } else {
+ return versionTimeBuilder_.getMessage();
+ }
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ public Builder setVersionTime(com.google.protobuf.Timestamp value) {
+ if (versionTimeBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ versionTime_ = value;
+ onChanged();
+ } else {
+ versionTimeBuilder_.setMessage(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ public Builder setVersionTime(com.google.protobuf.Timestamp.Builder builderForValue) {
+ if (versionTimeBuilder_ == null) {
+ versionTime_ = builderForValue.build();
+ onChanged();
+ } else {
+ versionTimeBuilder_.setMessage(builderForValue.build());
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ public Builder mergeVersionTime(com.google.protobuf.Timestamp value) {
+ if (versionTimeBuilder_ == null) {
+ if (versionTime_ != null) {
+ versionTime_ =
+ com.google.protobuf.Timestamp.newBuilder(versionTime_)
+ .mergeFrom(value)
+ .buildPartial();
+ } else {
+ versionTime_ = value;
+ }
+ onChanged();
+ } else {
+ versionTimeBuilder_.mergeFrom(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ public Builder clearVersionTime() {
+ if (versionTimeBuilder_ == null) {
+ versionTime_ = null;
+ onChanged();
+ } else {
+ versionTime_ = null;
+ versionTimeBuilder_ = null;
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ public com.google.protobuf.Timestamp.Builder getVersionTimeBuilder() {
+
+ onChanged();
+ return getVersionTimeFieldBuilder().getBuilder();
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ public com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder() {
+ if (versionTimeBuilder_ != null) {
+ return versionTimeBuilder_.getMessageOrBuilder();
+ } else {
+ return versionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : versionTime_;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>
+ getVersionTimeFieldBuilder() {
+ if (versionTimeBuilder_ == null) {
+ versionTimeBuilder_ =
+ new com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>(
+ getVersionTime(), getParentForChildren(), isClean());
+ versionTime_ = null;
+ }
+ return versionTimeBuilder_;
+ }
+
private com.google.protobuf.Timestamp expireTime_;
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp,
@@ -1703,10 +2010,9 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1722,10 +2028,9 @@ public boolean hasCreateTime() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1747,10 +2052,9 @@ public com.google.protobuf.Timestamp getCreateTime() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1774,10 +2078,9 @@ public Builder setCreateTime(com.google.protobuf.Timestamp value) {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1798,10 +2101,9 @@ public Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForVal
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1827,10 +2129,9 @@ public Builder mergeCreateTime(com.google.protobuf.Timestamp value) {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1852,10 +2153,9 @@ public Builder clearCreateTime() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1871,10 +2171,9 @@ public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
@@ -1894,10 +2193,9 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
*
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfo.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfo.java
index 99bc0f10191..56ce510e170 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfo.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfo.java
@@ -98,6 +98,21 @@ private BackupInfo(
java.lang.String s = input.readStringRequireUtf8();
sourceDatabase_ = s;
+ break;
+ }
+ case 34:
+ {
+ com.google.protobuf.Timestamp.Builder subBuilder = null;
+ if (versionTime_ != null) {
+ subBuilder = versionTime_.toBuilder();
+ }
+ versionTime_ =
+ input.readMessage(com.google.protobuf.Timestamp.parser(), extensionRegistry);
+ if (subBuilder != null) {
+ subBuilder.mergeFrom(versionTime_);
+ versionTime_ = subBuilder.buildPartial();
+ }
+
break;
}
default:
@@ -143,7 +158,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return The backup.
*/
@@ -166,7 +181,7 @@ public java.lang.String getBackup() {
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for backup.
*/
@@ -183,14 +198,72 @@ public com.google.protobuf.ByteString getBackupBytes() {
}
}
+ public static final int VERSION_TIME_FIELD_NUMBER = 4;
+ private com.google.protobuf.Timestamp versionTime_;
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ *
+ * @return Whether the versionTime field is set.
+ */
+ @java.lang.Override
+ public boolean hasVersionTime() {
+ return versionTime_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ *
+ * @return The versionTime.
+ */
+ @java.lang.Override
+ public com.google.protobuf.Timestamp getVersionTime() {
+ return versionTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : versionTime_;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ @java.lang.Override
+ public com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder() {
+ return getVersionTime();
+ }
+
public static final int CREATE_TIME_FIELD_NUMBER = 2;
private com.google.protobuf.Timestamp createTime_;
/**
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -205,8 +278,8 @@ public boolean hasCreateTime() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -221,8 +294,8 @@ public com.google.protobuf.Timestamp getCreateTime() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -241,7 +314,7 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return The sourceDatabase.
*/
@@ -264,7 +337,7 @@ public java.lang.String getSourceDatabase() {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for sourceDatabase.
*/
@@ -304,6 +377,9 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (!getSourceDatabaseBytes().isEmpty()) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 3, sourceDatabase_);
}
+ if (versionTime_ != null) {
+ output.writeMessage(4, getVersionTime());
+ }
unknownFields.writeTo(output);
}
@@ -322,6 +398,9 @@ public int getSerializedSize() {
if (!getSourceDatabaseBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(3, sourceDatabase_);
}
+ if (versionTime_ != null) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, getVersionTime());
+ }
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
@@ -339,6 +418,10 @@ public boolean equals(final java.lang.Object obj) {
(com.google.spanner.admin.database.v1.BackupInfo) obj;
if (!getBackup().equals(other.getBackup())) return false;
+ if (hasVersionTime() != other.hasVersionTime()) return false;
+ if (hasVersionTime()) {
+ if (!getVersionTime().equals(other.getVersionTime())) return false;
+ }
if (hasCreateTime() != other.hasCreateTime()) return false;
if (hasCreateTime()) {
if (!getCreateTime().equals(other.getCreateTime())) return false;
@@ -357,6 +440,10 @@ public int hashCode() {
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + BACKUP_FIELD_NUMBER;
hash = (53 * hash) + getBackup().hashCode();
+ if (hasVersionTime()) {
+ hash = (37 * hash) + VERSION_TIME_FIELD_NUMBER;
+ hash = (53 * hash) + getVersionTime().hashCode();
+ }
if (hasCreateTime()) {
hash = (37 * hash) + CREATE_TIME_FIELD_NUMBER;
hash = (53 * hash) + getCreateTime().hashCode();
@@ -510,6 +597,12 @@ public Builder clear() {
super.clear();
backup_ = "";
+ if (versionTimeBuilder_ == null) {
+ versionTime_ = null;
+ } else {
+ versionTime_ = null;
+ versionTimeBuilder_ = null;
+ }
if (createTimeBuilder_ == null) {
createTime_ = null;
} else {
@@ -546,6 +639,11 @@ public com.google.spanner.admin.database.v1.BackupInfo buildPartial() {
com.google.spanner.admin.database.v1.BackupInfo result =
new com.google.spanner.admin.database.v1.BackupInfo(this);
result.backup_ = backup_;
+ if (versionTimeBuilder_ == null) {
+ result.versionTime_ = versionTime_;
+ } else {
+ result.versionTime_ = versionTimeBuilder_.build();
+ }
if (createTimeBuilder_ == null) {
result.createTime_ = createTime_;
} else {
@@ -606,6 +704,9 @@ public Builder mergeFrom(com.google.spanner.admin.database.v1.BackupInfo other)
backup_ = other.backup_;
onChanged();
}
+ if (other.hasVersionTime()) {
+ mergeVersionTime(other.getVersionTime());
+ }
if (other.hasCreateTime()) {
mergeCreateTime(other.getCreateTime());
}
@@ -650,7 +751,7 @@ public Builder mergeFrom(
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return The backup.
*/
@@ -672,7 +773,7 @@ public java.lang.String getBackup() {
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for backup.
*/
@@ -694,7 +795,7 @@ public com.google.protobuf.ByteString getBackupBytes() {
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The backup to set.
* @return This builder for chaining.
@@ -715,7 +816,7 @@ public Builder setBackup(java.lang.String value) {
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return This builder for chaining.
*/
@@ -732,7 +833,7 @@ public Builder clearBackup() {
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The bytes for backup to set.
* @return This builder for chaining.
@@ -748,6 +849,227 @@ public Builder setBackupBytes(com.google.protobuf.ByteString value) {
return this;
}
+ private com.google.protobuf.Timestamp versionTime_;
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>
+ versionTimeBuilder_;
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ *
+ * @return Whether the versionTime field is set.
+ */
+ public boolean hasVersionTime() {
+ return versionTimeBuilder_ != null || versionTime_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ *
+ * @return The versionTime.
+ */
+ public com.google.protobuf.Timestamp getVersionTime() {
+ if (versionTimeBuilder_ == null) {
+ return versionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : versionTime_;
+ } else {
+ return versionTimeBuilder_.getMessage();
+ }
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ public Builder setVersionTime(com.google.protobuf.Timestamp value) {
+ if (versionTimeBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ versionTime_ = value;
+ onChanged();
+ } else {
+ versionTimeBuilder_.setMessage(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ public Builder setVersionTime(com.google.protobuf.Timestamp.Builder builderForValue) {
+ if (versionTimeBuilder_ == null) {
+ versionTime_ = builderForValue.build();
+ onChanged();
+ } else {
+ versionTimeBuilder_.setMessage(builderForValue.build());
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ public Builder mergeVersionTime(com.google.protobuf.Timestamp value) {
+ if (versionTimeBuilder_ == null) {
+ if (versionTime_ != null) {
+ versionTime_ =
+ com.google.protobuf.Timestamp.newBuilder(versionTime_)
+ .mergeFrom(value)
+ .buildPartial();
+ } else {
+ versionTime_ = value;
+ }
+ onChanged();
+ } else {
+ versionTimeBuilder_.mergeFrom(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ public Builder clearVersionTime() {
+ if (versionTimeBuilder_ == null) {
+ versionTime_ = null;
+ onChanged();
+ } else {
+ versionTime_ = null;
+ versionTimeBuilder_ = null;
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ public com.google.protobuf.Timestamp.Builder getVersionTimeBuilder() {
+
+ onChanged();
+ return getVersionTimeFieldBuilder().getBuilder();
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ public com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder() {
+ if (versionTimeBuilder_ != null) {
+ return versionTimeBuilder_.getMessageOrBuilder();
+ } else {
+ return versionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : versionTime_;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>
+ getVersionTimeFieldBuilder() {
+ if (versionTimeBuilder_ == null) {
+ versionTimeBuilder_ =
+ new com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>(
+ getVersionTime(), getParentForChildren(), isClean());
+ versionTime_ = null;
+ }
+ return versionTimeBuilder_;
+ }
+
private com.google.protobuf.Timestamp createTime_;
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Timestamp,
@@ -758,8 +1080,8 @@ public Builder setBackupBytes(com.google.protobuf.ByteString value) {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -773,8 +1095,8 @@ public boolean hasCreateTime() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -794,8 +1116,8 @@ public com.google.protobuf.Timestamp getCreateTime() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -817,8 +1139,8 @@ public Builder setCreateTime(com.google.protobuf.Timestamp value) {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -837,8 +1159,8 @@ public Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForVal
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -862,8 +1184,8 @@ public Builder mergeCreateTime(com.google.protobuf.Timestamp value) {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -883,8 +1205,8 @@ public Builder clearCreateTime() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -898,8 +1220,8 @@ public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -917,8 +1239,8 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -948,7 +1270,7 @@ public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return The sourceDatabase.
*/
@@ -970,7 +1292,7 @@ public java.lang.String getSourceDatabase() {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for sourceDatabase.
*/
@@ -992,7 +1314,7 @@ public com.google.protobuf.ByteString getSourceDatabaseBytes() {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @param value The sourceDatabase to set.
* @return This builder for chaining.
@@ -1013,7 +1335,7 @@ public Builder setSourceDatabase(java.lang.String value) {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return This builder for chaining.
*/
@@ -1030,7 +1352,7 @@ public Builder clearSourceDatabase() {
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @param value The bytes for sourceDatabase to set.
* @return This builder for chaining.
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfoOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfoOrBuilder.java
index 250b63bc124..0d3766f1a33 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfoOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupInfoOrBuilder.java
@@ -30,7 +30,7 @@ public interface BackupInfoOrBuilder
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return The backup.
*/
@@ -42,7 +42,7 @@ public interface BackupInfoOrBuilder
* Name of the backup.
*
*
- * string backup = 1;
+ * string backup = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for backup.
*/
@@ -53,7 +53,54 @@ public interface BackupInfoOrBuilder
*
*
* The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ *
+ * @return Whether the versionTime field is set.
+ */
+ boolean hasVersionTime();
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ *
+ * @return The versionTime.
+ */
+ com.google.protobuf.Timestamp getVersionTime();
+ /**
+ *
+ *
+ *
+ * The backup contains an externally consistent copy of `source_database` at
+ * the timestamp specified by `version_time`. If the
+ * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ * `version_time`, the `version_time` of the backup is equivalent to the
+ * `create_time`.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 4;
+ */
+ com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder();
+
+ /**
+ *
+ *
+ *
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -65,8 +112,8 @@ public interface BackupInfoOrBuilder
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -78,8 +125,8 @@ public interface BackupInfoOrBuilder
*
*
*
- * The backup contains an externally consistent copy of `source_database` at
- * the timestamp specified by `create_time`.
+ * The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ * received.
*
*
* .google.protobuf.Timestamp create_time = 2;
@@ -93,7 +140,7 @@ public interface BackupInfoOrBuilder
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return The sourceDatabase.
*/
@@ -105,7 +152,7 @@ public interface BackupInfoOrBuilder
* Name of the database the backup was created from.
*
*
- * string source_database = 3;
+ * string source_database = 3 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for sourceDatabase.
*/
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupOrBuilder.java
index 2b7f566b122..67cfab26fc9 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupOrBuilder.java
@@ -56,6 +56,50 @@ public interface BackupOrBuilder
*/
com.google.protobuf.ByteString getDatabaseBytes();
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ *
+ * @return Whether the versionTime field is set.
+ */
+ boolean hasVersionTime();
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ *
+ * @return The versionTime.
+ */
+ com.google.protobuf.Timestamp getVersionTime();
+ /**
+ *
+ *
+ *
+ * The backup will contain an externally consistent copy of the database at
+ * the timestamp specified by `version_time`. If `version_time` is not
+ * specified, the system will set `version_time` to the `create_time` of the
+ * backup.
+ *
+ *
+ * .google.protobuf.Timestamp version_time = 9;
+ */
+ com.google.protobuf.TimestampOrBuilder getVersionTimeOrBuilder();
+
/**
*
*
@@ -155,10 +199,9 @@ public interface BackupOrBuilder
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
@@ -171,10 +214,9 @@ public interface BackupOrBuilder
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
@@ -187,10 +229,9 @@ public interface BackupOrBuilder
*
*
*
- * Output only. The backup will contain an externally consistent
- * copy of the database at the timestamp specified by
- * `create_time`. `create_time` is approximately the time the
- * [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ * Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ * request is received. If the request does not specify `version_time`, the
+ * `version_time` of the backup will be equivalent to the `create_time`.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupProto.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupProto.java
index 2aaecf7bcd8..dd28586f35e 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupProto.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/BackupProto.java
@@ -88,56 +88,62 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "d_mask.proto\032\037google/protobuf/timestamp."
+ "proto\032-google/spanner/admin/database/v1/"
+ "common.proto\032\034google/api/annotations.pro"
- + "to\"\315\003\n\006Backup\0226\n\010database\030\002 \001(\tB$\372A!\n\037sp"
- + "anner.googleapis.com/Database\022/\n\013expire_"
- + "time\030\003 \001(\0132\032.google.protobuf.Timestamp\022\014"
- + "\n\004name\030\001 \001(\t\0224\n\013create_time\030\004 \001(\0132\032.goog"
- + "le.protobuf.TimestampB\003\340A\003\022\027\n\nsize_bytes"
- + "\030\005 \001(\003B\003\340A\003\022B\n\005state\030\006 \001(\0162..google.span"
- + "ner.admin.database.v1.Backup.StateB\003\340A\003\022"
- + "\"\n\025referencing_databases\030\007 \003(\tB\003\340A\003\"7\n\005S"
- + "tate\022\025\n\021STATE_UNSPECIFIED\020\000\022\014\n\010CREATING\020"
- + "\001\022\t\n\005READY\020\002:\\\352AY\n\035spanner.googleapis.co"
- + "m/Backup\0228projects/{project}/instances/{"
- + "instance}/backups/{backup}\"\245\001\n\023CreateBac"
- + "kupRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\n\037span"
- + "ner.googleapis.com/Instance\022\026\n\tbackup_id"
- + "\030\002 \001(\tB\003\340A\002\022=\n\006backup\030\003 \001(\0132(.google.spa"
- + "nner.admin.database.v1.BackupB\003\340A\002\"\256\001\n\024C"
- + "reateBackupMetadata\022\014\n\004name\030\001 \001(\t\022\020\n\010dat"
- + "abase\030\002 \001(\t\022E\n\010progress\030\003 \001(\01323.google.s"
- + "panner.admin.database.v1.OperationProgre"
- + "ss\022/\n\013cancel_time\030\004 \001(\0132\032.google.protobu"
- + "f.Timestamp\"\212\001\n\023UpdateBackupRequest\022=\n\006b"
- + "ackup\030\001 \001(\0132(.google.spanner.admin.datab"
- + "ase.v1.BackupB\003\340A\002\0224\n\013update_mask\030\002 \001(\0132"
- + "\032.google.protobuf.FieldMaskB\003\340A\002\"G\n\020GetB"
+ + "to\"\377\003\n\006Backup\0226\n\010database\030\002 \001(\tB$\372A!\n\037sp"
+ + "anner.googleapis.com/Database\0220\n\014version"
+ + "_time\030\t \001(\0132\032.google.protobuf.Timestamp\022"
+ + "/\n\013expire_time\030\003 \001(\0132\032.google.protobuf.T"
+ + "imestamp\022\014\n\004name\030\001 \001(\t\0224\n\013create_time\030\004 "
+ + "\001(\0132\032.google.protobuf.TimestampB\003\340A\003\022\027\n\n"
+ + "size_bytes\030\005 \001(\003B\003\340A\003\022B\n\005state\030\006 \001(\0162..g"
+ + "oogle.spanner.admin.database.v1.Backup.S"
+ + "tateB\003\340A\003\022\"\n\025referencing_databases\030\007 \003(\t"
+ + "B\003\340A\003\"7\n\005State\022\025\n\021STATE_UNSPECIFIED\020\000\022\014\n"
+ + "\010CREATING\020\001\022\t\n\005READY\020\002:\\\352AY\n\035spanner.goo"
+ + "gleapis.com/Backup\0228projects/{project}/i"
+ + "nstances/{instance}/backups/{backup}\"\245\001\n"
+ + "\023CreateBackupRequest\0227\n\006parent\030\001 \001(\tB\'\340A"
+ + "\002\372A!\n\037spanner.googleapis.com/Instance\022\026\n"
+ + "\tbackup_id\030\002 \001(\tB\003\340A\002\022=\n\006backup\030\003 \001(\0132(."
+ + "google.spanner.admin.database.v1.BackupB"
+ + "\003\340A\002\"\370\001\n\024CreateBackupMetadata\0220\n\004name\030\001 "
+ + "\001(\tB\"\372A\037\n\035spanner.googleapis.com/Backup\022"
+ + "6\n\010database\030\002 \001(\tB$\372A!\n\037spanner.googleap"
+ + "is.com/Database\022E\n\010progress\030\003 \001(\01323.goog"
+ + "le.spanner.admin.database.v1.OperationPr"
+ + "ogress\022/\n\013cancel_time\030\004 \001(\0132\032.google.pro"
+ + "tobuf.Timestamp\"\212\001\n\023UpdateBackupRequest\022"
+ + "=\n\006backup\030\001 \001(\0132(.google.spanner.admin.d"
+ + "atabase.v1.BackupB\003\340A\002\0224\n\013update_mask\030\002 "
+ + "\001(\0132\032.google.protobuf.FieldMaskB\003\340A\002\"G\n\020"
+ + "GetBackupRequest\0223\n\004name\030\001 \001(\tB%\340A\002\372A\037\n\035"
+ + "spanner.googleapis.com/Backup\"J\n\023DeleteB"
+ "ackupRequest\0223\n\004name\030\001 \001(\tB%\340A\002\372A\037\n\035span"
- + "ner.googleapis.com/Backup\"J\n\023DeleteBacku"
- + "pRequest\0223\n\004name\030\001 \001(\tB%\340A\002\372A\037\n\035spanner."
- + "googleapis.com/Backup\"\204\001\n\022ListBackupsReq"
- + "uest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\n\037spanner.go"
- + "ogleapis.com/Instance\022\016\n\006filter\030\002 \001(\t\022\021\n"
- + "\tpage_size\030\003 \001(\005\022\022\n\npage_token\030\004 \001(\t\"i\n\023"
- + "ListBackupsResponse\0229\n\007backups\030\001 \003(\0132(.g"
- + "oogle.spanner.admin.database.v1.Backup\022\027"
- + "\n\017next_page_token\030\002 \001(\t\"\215\001\n\033ListBackupOp"
- + "erationsRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\n"
- + "\037spanner.googleapis.com/Instance\022\016\n\006filt"
- + "er\030\002 \001(\t\022\021\n\tpage_size\030\003 \001(\005\022\022\n\npage_toke"
- + "n\030\004 \001(\t\"j\n\034ListBackupOperationsResponse\022"
- + "1\n\noperations\030\001 \003(\0132\035.google.longrunning"
- + ".Operation\022\027\n\017next_page_token\030\002 \001(\t\"f\n\nB"
- + "ackupInfo\022\016\n\006backup\030\001 \001(\t\022/\n\013create_time"
- + "\030\002 \001(\0132\032.google.protobuf.Timestamp\022\027\n\017so"
- + "urce_database\030\003 \001(\tB\377\001\n$com.google.spann"
- + "er.admin.database.v1B\013BackupProtoP\001ZHgoo"
- + "gle.golang.org/genproto/googleapis/spann"
- + "er/admin/database/v1;database\252\002&Google.C"
- + "loud.Spanner.Admin.Database.V1\312\002&Google\\"
- + "Cloud\\Spanner\\Admin\\Database\\V1\352\002+Google"
- + "::Cloud::Spanner::Admin::Database::V1b\006p"
- + "roto3"
+ + "ner.googleapis.com/Backup\"\204\001\n\022ListBackup"
+ + "sRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002\372A!\n\037spanne"
+ + "r.googleapis.com/Instance\022\016\n\006filter\030\002 \001("
+ + "\t\022\021\n\tpage_size\030\003 \001(\005\022\022\n\npage_token\030\004 \001(\t"
+ + "\"i\n\023ListBackupsResponse\0229\n\007backups\030\001 \003(\013"
+ + "2(.google.spanner.admin.database.v1.Back"
+ + "up\022\027\n\017next_page_token\030\002 \001(\t\"\215\001\n\033ListBack"
+ + "upOperationsRequest\0227\n\006parent\030\001 \001(\tB\'\340A\002"
+ + "\372A!\n\037spanner.googleapis.com/Instance\022\016\n\006"
+ + "filter\030\002 \001(\t\022\021\n\tpage_size\030\003 \001(\005\022\022\n\npage_"
+ + "token\030\004 \001(\t\"j\n\034ListBackupOperationsRespo"
+ + "nse\0221\n\noperations\030\001 \003(\0132\035.google.longrun"
+ + "ning.Operation\022\027\n\017next_page_token\030\002 \001(\t\""
+ + "\342\001\n\nBackupInfo\0222\n\006backup\030\001 \001(\tB\"\372A\037\n\035spa"
+ + "nner.googleapis.com/Backup\0220\n\014version_ti"
+ + "me\030\004 \001(\0132\032.google.protobuf.Timestamp\022/\n\013"
+ + "create_time\030\002 \001(\0132\032.google.protobuf.Time"
+ + "stamp\022=\n\017source_database\030\003 \001(\tB$\372A!\n\037spa"
+ + "nner.googleapis.com/DatabaseB\377\001\n$com.goo"
+ + "gle.spanner.admin.database.v1B\013BackupPro"
+ + "toP\001ZHgoogle.golang.org/genproto/googlea"
+ + "pis/spanner/admin/database/v1;database\252\002"
+ + "&Google.Cloud.Spanner.Admin.Database.V1\312"
+ + "\002&Google\\Cloud\\Spanner\\Admin\\Database\\V1"
+ + "\352\002+Google::Cloud::Spanner::Admin::Databa"
+ + "se::V1b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
@@ -158,6 +164,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
internal_static_google_spanner_admin_database_v1_Backup_descriptor,
new java.lang.String[] {
"Database",
+ "VersionTime",
"ExpireTime",
"Name",
"CreateTime",
@@ -243,7 +250,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
new com.google.protobuf.GeneratedMessageV3.FieldAccessorTable(
internal_static_google_spanner_admin_database_v1_BackupInfo_descriptor,
new java.lang.String[] {
- "Backup", "CreateTime", "SourceDatabase",
+ "Backup", "VersionTime", "CreateTime", "SourceDatabase",
});
com.google.protobuf.ExtensionRegistry registry =
com.google.protobuf.ExtensionRegistry.newInstance();
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadata.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadata.java
index a1b0cc35124..c4e23c96e69 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadata.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadata.java
@@ -161,7 +161,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -184,7 +184,7 @@ public java.lang.String getName() {
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -210,7 +210,7 @@ public com.google.protobuf.ByteString getNameBytes() {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return The database.
*/
@@ -233,7 +233,7 @@ public java.lang.String getDatabase() {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for database.
*/
@@ -777,7 +777,7 @@ public Builder mergeFrom(
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -799,7 +799,7 @@ public java.lang.String getName() {
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -821,7 +821,7 @@ public com.google.protobuf.ByteString getNameBytes() {
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The name to set.
* @return This builder for chaining.
@@ -842,7 +842,7 @@ public Builder setName(java.lang.String value) {
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return This builder for chaining.
*/
@@ -859,7 +859,7 @@ public Builder clearName() {
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The bytes for name to set.
* @return This builder for chaining.
@@ -883,7 +883,7 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return The database.
*/
@@ -905,7 +905,7 @@ public java.lang.String getDatabase() {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for database.
*/
@@ -927,7 +927,7 @@ public com.google.protobuf.ByteString getDatabaseBytes() {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @param value The database to set.
* @return This builder for chaining.
@@ -948,7 +948,7 @@ public Builder setDatabase(java.lang.String value) {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return This builder for chaining.
*/
@@ -965,7 +965,7 @@ public Builder clearDatabase() {
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @param value The bytes for database to set.
* @return This builder for chaining.
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadataOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadataOrBuilder.java
index 5034e3af02d..fcb89c03472 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadataOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/CreateBackupMetadataOrBuilder.java
@@ -30,7 +30,7 @@ public interface CreateBackupMetadataOrBuilder
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -42,7 +42,7 @@ public interface CreateBackupMetadataOrBuilder
* The name of the backup being created.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -55,7 +55,7 @@ public interface CreateBackupMetadataOrBuilder
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return The database.
*/
@@ -67,7 +67,7 @@ public interface CreateBackupMetadataOrBuilder
* The name of the database the backup is created from.
*
*
- * string database = 2;
+ * string database = 2 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for database.
*/
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/Database.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/Database.java
index 768f470254d..f4c866c8f85 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/Database.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/Database.java
@@ -40,6 +40,7 @@ private Database(com.google.protobuf.GeneratedMessageV3.Builder builder) {
private Database() {
name_ = "";
state_ = 0;
+ versionRetentionPeriod_ = "";
}
@java.lang.Override
@@ -114,6 +115,28 @@ private Database(
restoreInfo_ = subBuilder.buildPartial();
}
+ break;
+ }
+ case 50:
+ {
+ java.lang.String s = input.readStringRequireUtf8();
+
+ versionRetentionPeriod_ = s;
+ break;
+ }
+ case 58:
+ {
+ com.google.protobuf.Timestamp.Builder subBuilder = null;
+ if (earliestVersionTime_ != null) {
+ subBuilder = earliestVersionTime_.toBuilder();
+ }
+ earliestVersionTime_ =
+ input.readMessage(com.google.protobuf.Timestamp.parser(), extensionRegistry);
+ if (subBuilder != null) {
+ subBuilder.mergeFrom(earliestVersionTime_);
+ earliestVersionTime_ = subBuilder.buildPartial();
+ }
+
break;
}
default:
@@ -548,6 +571,120 @@ public com.google.spanner.admin.database.v1.RestoreInfoOrBuilder getRestoreInfoO
return getRestoreInfo();
}
+ public static final int VERSION_RETENTION_PERIOD_FIELD_NUMBER = 6;
+ private volatile java.lang.Object versionRetentionPeriod_;
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The versionRetentionPeriod.
+ */
+ @java.lang.Override
+ public java.lang.String getVersionRetentionPeriod() {
+ java.lang.Object ref = versionRetentionPeriod_;
+ if (ref instanceof java.lang.String) {
+ return (java.lang.String) ref;
+ } else {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ versionRetentionPeriod_ = s;
+ return s;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The bytes for versionRetentionPeriod.
+ */
+ @java.lang.Override
+ public com.google.protobuf.ByteString getVersionRetentionPeriodBytes() {
+ java.lang.Object ref = versionRetentionPeriod_;
+ if (ref instanceof java.lang.String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ versionRetentionPeriod_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+
+ public static final int EARLIEST_VERSION_TIME_FIELD_NUMBER = 7;
+ private com.google.protobuf.Timestamp earliestVersionTime_;
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return Whether the earliestVersionTime field is set.
+ */
+ @java.lang.Override
+ public boolean hasEarliestVersionTime() {
+ return earliestVersionTime_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return The earliestVersionTime.
+ */
+ @java.lang.Override
+ public com.google.protobuf.Timestamp getEarliestVersionTime() {
+ return earliestVersionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : earliestVersionTime_;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ @java.lang.Override
+ public com.google.protobuf.TimestampOrBuilder getEarliestVersionTimeOrBuilder() {
+ return getEarliestVersionTime();
+ }
+
private byte memoizedIsInitialized = -1;
@java.lang.Override
@@ -575,6 +712,12 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (restoreInfo_ != null) {
output.writeMessage(4, getRestoreInfo());
}
+ if (!getVersionRetentionPeriodBytes().isEmpty()) {
+ com.google.protobuf.GeneratedMessageV3.writeString(output, 6, versionRetentionPeriod_);
+ }
+ if (earliestVersionTime_ != null) {
+ output.writeMessage(7, getEarliestVersionTime());
+ }
unknownFields.writeTo(output);
}
@@ -597,6 +740,12 @@ public int getSerializedSize() {
if (restoreInfo_ != null) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, getRestoreInfo());
}
+ if (!getVersionRetentionPeriodBytes().isEmpty()) {
+ size += com.google.protobuf.GeneratedMessageV3.computeStringSize(6, versionRetentionPeriod_);
+ }
+ if (earliestVersionTime_ != null) {
+ size += com.google.protobuf.CodedOutputStream.computeMessageSize(7, getEarliestVersionTime());
+ }
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
@@ -623,6 +772,11 @@ public boolean equals(final java.lang.Object obj) {
if (hasRestoreInfo()) {
if (!getRestoreInfo().equals(other.getRestoreInfo())) return false;
}
+ if (!getVersionRetentionPeriod().equals(other.getVersionRetentionPeriod())) return false;
+ if (hasEarliestVersionTime() != other.hasEarliestVersionTime()) return false;
+ if (hasEarliestVersionTime()) {
+ if (!getEarliestVersionTime().equals(other.getEarliestVersionTime())) return false;
+ }
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@@ -646,6 +800,12 @@ public int hashCode() {
hash = (37 * hash) + RESTORE_INFO_FIELD_NUMBER;
hash = (53 * hash) + getRestoreInfo().hashCode();
}
+ hash = (37 * hash) + VERSION_RETENTION_PERIOD_FIELD_NUMBER;
+ hash = (53 * hash) + getVersionRetentionPeriod().hashCode();
+ if (hasEarliestVersionTime()) {
+ hash = (37 * hash) + EARLIEST_VERSION_TIME_FIELD_NUMBER;
+ hash = (53 * hash) + getEarliestVersionTime().hashCode();
+ }
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
@@ -807,6 +967,14 @@ public Builder clear() {
restoreInfo_ = null;
restoreInfoBuilder_ = null;
}
+ versionRetentionPeriod_ = "";
+
+ if (earliestVersionTimeBuilder_ == null) {
+ earliestVersionTime_ = null;
+ } else {
+ earliestVersionTime_ = null;
+ earliestVersionTimeBuilder_ = null;
+ }
return this;
}
@@ -846,6 +1014,12 @@ public com.google.spanner.admin.database.v1.Database buildPartial() {
} else {
result.restoreInfo_ = restoreInfoBuilder_.build();
}
+ result.versionRetentionPeriod_ = versionRetentionPeriod_;
+ if (earliestVersionTimeBuilder_ == null) {
+ result.earliestVersionTime_ = earliestVersionTime_;
+ } else {
+ result.earliestVersionTime_ = earliestVersionTimeBuilder_.build();
+ }
onBuilt();
return result;
}
@@ -908,6 +1082,13 @@ public Builder mergeFrom(com.google.spanner.admin.database.v1.Database other) {
if (other.hasRestoreInfo()) {
mergeRestoreInfo(other.getRestoreInfo());
}
+ if (!other.getVersionRetentionPeriod().isEmpty()) {
+ versionRetentionPeriod_ = other.versionRetentionPeriod_;
+ onChanged();
+ }
+ if (other.hasEarliestVersionTime()) {
+ mergeEarliestVersionTime(other.getEarliestVersionTime());
+ }
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
@@ -1580,6 +1761,349 @@ public com.google.spanner.admin.database.v1.RestoreInfoOrBuilder getRestoreInfoO
return restoreInfoBuilder_;
}
+ private java.lang.Object versionRetentionPeriod_ = "";
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return The versionRetentionPeriod.
+ */
+ public java.lang.String getVersionRetentionPeriod() {
+ java.lang.Object ref = versionRetentionPeriod_;
+ if (!(ref instanceof java.lang.String)) {
+ com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
+ java.lang.String s = bs.toStringUtf8();
+ versionRetentionPeriod_ = s;
+ return s;
+ } else {
+ return (java.lang.String) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return The bytes for versionRetentionPeriod.
+ */
+ public com.google.protobuf.ByteString getVersionRetentionPeriodBytes() {
+ java.lang.Object ref = versionRetentionPeriod_;
+ if (ref instanceof String) {
+ com.google.protobuf.ByteString b =
+ com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
+ versionRetentionPeriod_ = b;
+ return b;
+ } else {
+ return (com.google.protobuf.ByteString) ref;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @param value The versionRetentionPeriod to set.
+ * @return This builder for chaining.
+ */
+ public Builder setVersionRetentionPeriod(java.lang.String value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+
+ versionRetentionPeriod_ = value;
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return This builder for chaining.
+ */
+ public Builder clearVersionRetentionPeriod() {
+
+ versionRetentionPeriod_ = getDefaultInstance().getVersionRetentionPeriod();
+ onChanged();
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @param value The bytes for versionRetentionPeriod to set.
+ * @return This builder for chaining.
+ */
+ public Builder setVersionRetentionPeriodBytes(com.google.protobuf.ByteString value) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ checkByteStringIsUtf8(value);
+
+ versionRetentionPeriod_ = value;
+ onChanged();
+ return this;
+ }
+
+ private com.google.protobuf.Timestamp earliestVersionTime_;
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>
+ earliestVersionTimeBuilder_;
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return Whether the earliestVersionTime field is set.
+ */
+ public boolean hasEarliestVersionTime() {
+ return earliestVersionTimeBuilder_ != null || earliestVersionTime_ != null;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return The earliestVersionTime.
+ */
+ public com.google.protobuf.Timestamp getEarliestVersionTime() {
+ if (earliestVersionTimeBuilder_ == null) {
+ return earliestVersionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : earliestVersionTime_;
+ } else {
+ return earliestVersionTimeBuilder_.getMessage();
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ public Builder setEarliestVersionTime(com.google.protobuf.Timestamp value) {
+ if (earliestVersionTimeBuilder_ == null) {
+ if (value == null) {
+ throw new NullPointerException();
+ }
+ earliestVersionTime_ = value;
+ onChanged();
+ } else {
+ earliestVersionTimeBuilder_.setMessage(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ public Builder setEarliestVersionTime(com.google.protobuf.Timestamp.Builder builderForValue) {
+ if (earliestVersionTimeBuilder_ == null) {
+ earliestVersionTime_ = builderForValue.build();
+ onChanged();
+ } else {
+ earliestVersionTimeBuilder_.setMessage(builderForValue.build());
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ public Builder mergeEarliestVersionTime(com.google.protobuf.Timestamp value) {
+ if (earliestVersionTimeBuilder_ == null) {
+ if (earliestVersionTime_ != null) {
+ earliestVersionTime_ =
+ com.google.protobuf.Timestamp.newBuilder(earliestVersionTime_)
+ .mergeFrom(value)
+ .buildPartial();
+ } else {
+ earliestVersionTime_ = value;
+ }
+ onChanged();
+ } else {
+ earliestVersionTimeBuilder_.mergeFrom(value);
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ public Builder clearEarliestVersionTime() {
+ if (earliestVersionTimeBuilder_ == null) {
+ earliestVersionTime_ = null;
+ onChanged();
+ } else {
+ earliestVersionTime_ = null;
+ earliestVersionTimeBuilder_ = null;
+ }
+
+ return this;
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ public com.google.protobuf.Timestamp.Builder getEarliestVersionTimeBuilder() {
+
+ onChanged();
+ return getEarliestVersionTimeFieldBuilder().getBuilder();
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ public com.google.protobuf.TimestampOrBuilder getEarliestVersionTimeOrBuilder() {
+ if (earliestVersionTimeBuilder_ != null) {
+ return earliestVersionTimeBuilder_.getMessageOrBuilder();
+ } else {
+ return earliestVersionTime_ == null
+ ? com.google.protobuf.Timestamp.getDefaultInstance()
+ : earliestVersionTime_;
+ }
+ }
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ private com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>
+ getEarliestVersionTimeFieldBuilder() {
+ if (earliestVersionTimeBuilder_ == null) {
+ earliestVersionTimeBuilder_ =
+ new com.google.protobuf.SingleFieldBuilderV3<
+ com.google.protobuf.Timestamp,
+ com.google.protobuf.Timestamp.Builder,
+ com.google.protobuf.TimestampOrBuilder>(
+ getEarliestVersionTime(), getParentForChildren(), isClean());
+ earliestVersionTime_ = null;
+ }
+ return earliestVersionTimeBuilder_;
+ }
+
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/DatabaseOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/DatabaseOrBuilder.java
index 4c4869319f2..9ca843fc93f 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/DatabaseOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/DatabaseOrBuilder.java
@@ -166,4 +166,81 @@ public interface DatabaseOrBuilder
*
*/
com.google.spanner.admin.database.v1.RestoreInfoOrBuilder getRestoreInfoOrBuilder();
+
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The versionRetentionPeriod.
+ */
+ java.lang.String getVersionRetentionPeriod();
+ /**
+ *
+ *
+ *
+ * Output only. The period in which Cloud Spanner retains all versions of data
+ * for the database. This is the same as the value of version_retention_period
+ * database option set using
+ * [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ * if not set.
+ *
+ *
+ * string version_retention_period = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ * @return The bytes for versionRetentionPeriod.
+ */
+ com.google.protobuf.ByteString getVersionRetentionPeriodBytes();
+
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return Whether the earliestVersionTime field is set.
+ */
+ boolean hasEarliestVersionTime();
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ *
+ * @return The earliestVersionTime.
+ */
+ com.google.protobuf.Timestamp getEarliestVersionTime();
+ /**
+ *
+ *
+ *
+ * Output only. Earliest timestamp at which older versions of the data can be
+ * read.
+ *
+ *
+ *
+ * .google.protobuf.Timestamp earliest_version_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
+ *
+ */
+ com.google.protobuf.TimestampOrBuilder getEarliestVersionTimeOrBuilder();
}
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequest.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequest.java
index d730718fb37..f5bc73b7d83 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequest.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequest.java
@@ -118,6 +118,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -143,6 +145,8 @@ public java.lang.String getDatabase() {
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -489,6 +493,8 @@ public Builder mergeFrom(
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -513,6 +519,8 @@ public java.lang.String getDatabase() {
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -537,6 +545,8 @@ public com.google.protobuf.ByteString getDatabaseBytes() {
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -560,6 +570,8 @@ public Builder setDatabase(java.lang.String value) {
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -579,6 +591,8 @@ public Builder clearDatabase() {
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequestOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequestOrBuilder.java
index 2e7da9cf5a4..2469460dc3e 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequestOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/GetDatabaseDdlRequestOrBuilder.java
@@ -28,6 +28,8 @@ public interface GetDatabaseDdlRequestOrBuilder
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
@@ -42,6 +44,8 @@ public interface GetDatabaseDdlRequestOrBuilder
*
*
* Required. The database whose schema we wish to get.
+ * Values are of the form
+ * `projects/<project>/instances/<instance>/databases/<database>`
*
*
*
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequest.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequest.java
index baea7c8f1ff..a49ee408beb 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequest.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequest.java
@@ -218,9 +218,9 @@ public com.google.protobuf.ByteString getParentBytes() {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -272,9 +272,9 @@ public java.lang.String getFilter() {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -894,9 +894,9 @@ public Builder setParentBytes(com.google.protobuf.ByteString value) {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -947,9 +947,9 @@ public java.lang.String getFilter() {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -1000,9 +1000,9 @@ public com.google.protobuf.ByteString getFilterBytes() {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -1052,9 +1052,9 @@ public Builder setFilter(java.lang.String value) {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -1100,9 +1100,9 @@ public Builder clearFilter() {
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequestOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequestOrBuilder.java
index 4f43eba2884..6d48d7f5f3f 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequestOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListBackupOperationsRequestOrBuilder.java
@@ -82,9 +82,9 @@ public interface ListBackupOperationsRequestOrBuilder
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
@@ -125,9 +125,9 @@ public interface ListBackupOperationsRequestOrBuilder
* * `done:true` - The operation is complete.
* * `metadata.database:prod` - The database the backup was taken from has
* a name containing the string "prod".
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` <br/>
- * `(metadata.name:howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ * `(metadata.name:howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Returns operations where:
* * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
* * The backup name contains the string "howl".
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequest.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequest.java
index 06cff39b688..d59caa1f7de 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequest.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequest.java
@@ -216,11 +216,11 @@ public com.google.protobuf.ByteString getParentBytes() {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -272,11 +272,11 @@ public java.lang.String getFilter() {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -900,11 +900,11 @@ public Builder setParentBytes(com.google.protobuf.ByteString value) {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -955,11 +955,11 @@ public java.lang.String getFilter() {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -1010,11 +1010,11 @@ public com.google.protobuf.ByteString getFilterBytes() {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -1064,11 +1064,11 @@ public Builder setFilter(java.lang.String value) {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -1114,11 +1114,11 @@ public Builder clearFilter() {
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequestOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequestOrBuilder.java
index 115dcd7551a..38eb5693e1a 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequestOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/ListDatabaseOperationsRequestOrBuilder.java
@@ -80,11 +80,11 @@ public interface ListDatabaseOperationsRequestOrBuilder
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
@@ -125,11 +125,11 @@ public interface ListDatabaseOperationsRequestOrBuilder
* you can specify AND, OR, and NOT logic explicitly.
* Here are a few examples:
* * `done:true` - The operation is complete.
- * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
- * `(metadata.source_type:BACKUP) AND` <br/>
- * `(metadata.backup_info.backup:backup_howl) AND` <br/>
- * `(metadata.name:restored_howl) AND` <br/>
- * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+ * * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ * `(metadata.source_type:BACKUP) AND` \
+ * `(metadata.backup_info.backup:backup_howl) AND` \
+ * `(metadata.name:restored_howl) AND` \
+ * `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
* `(error:*)` - Return operations where:
* * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
* * The database is restored from a backup.
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadata.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadata.java
index 88c49cdc159..6bdf68bc71c 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadata.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadata.java
@@ -141,7 +141,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -164,7 +164,7 @@ public java.lang.String getName() {
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -595,7 +595,7 @@ public Builder mergeFrom(
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -617,7 +617,7 @@ public java.lang.String getName() {
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -639,7 +639,7 @@ public com.google.protobuf.ByteString getNameBytes() {
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The name to set.
* @return This builder for chaining.
@@ -660,7 +660,7 @@ public Builder setName(java.lang.String value) {
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return This builder for chaining.
*/
@@ -677,7 +677,7 @@ public Builder clearName() {
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The bytes for name to set.
* @return This builder for chaining.
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadataOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadataOrBuilder.java
index a5a211d446b..0606518a011 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadataOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/OptimizeRestoredDatabaseMetadataOrBuilder.java
@@ -30,7 +30,7 @@ public interface OptimizeRestoredDatabaseMetadataOrBuilder
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -42,7 +42,7 @@ public interface OptimizeRestoredDatabaseMetadataOrBuilder
* Name of the restored database being optimized.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadata.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadata.java
index 4cb99151034..8a849d56711 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadata.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadata.java
@@ -230,7 +230,7 @@ public SourceInfoCase getSourceInfoCase() {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -253,7 +253,7 @@ public java.lang.String getName() {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -1039,7 +1039,7 @@ public Builder clearSourceInfo() {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -1061,7 +1061,7 @@ public java.lang.String getName() {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
@@ -1083,7 +1083,7 @@ public com.google.protobuf.ByteString getNameBytes() {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The name to set.
* @return This builder for chaining.
@@ -1104,7 +1104,7 @@ public Builder setName(java.lang.String value) {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return This builder for chaining.
*/
@@ -1121,7 +1121,7 @@ public Builder clearName() {
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @param value The bytes for name to set.
* @return This builder for chaining.
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadataOrBuilder.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadataOrBuilder.java
index 8d05e8b6b7c..35ad6d76e9d 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadataOrBuilder.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/RestoreDatabaseMetadataOrBuilder.java
@@ -30,7 +30,7 @@ public interface RestoreDatabaseMetadataOrBuilder
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The name.
*/
@@ -42,7 +42,7 @@ public interface RestoreDatabaseMetadataOrBuilder
* Name of the database being created and restored to.
*
*
- * string name = 1;
+ * string name = 1 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for name.
*/
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/SpannerDatabaseAdminProto.java b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/SpannerDatabaseAdminProto.java
index 032a813e29b..7b981be4f45 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/SpannerDatabaseAdminProto.java
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/java/com/google/spanner/admin/database/v1/SpannerDatabaseAdminProto.java
@@ -120,176 +120,181 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "admin.database.v1.RestoreSourceType\022C\n\013b"
+ "ackup_info\030\002 \001(\0132,.google.spanner.admin."
+ "database.v1.BackupInfoH\000B\r\n\013source_info\""
- + "\226\003\n\010Database\022\021\n\004name\030\001 \001(\tB\003\340A\002\022D\n\005state"
+ + "\375\003\n\010Database\022\021\n\004name\030\001 \001(\tB\003\340A\002\022D\n\005state"
+ "\030\002 \001(\01620.google.spanner.admin.database.v"
+ "1.Database.StateB\003\340A\003\0224\n\013create_time\030\003 \001"
+ "(\0132\032.google.protobuf.TimestampB\003\340A\003\022H\n\014r"
+ "estore_info\030\004 \001(\0132-.google.spanner.admin"
- + ".database.v1.RestoreInfoB\003\340A\003\"M\n\005State\022\025"
- + "\n\021STATE_UNSPECIFIED\020\000\022\014\n\010CREATING\020\001\022\t\n\005R"
- + "EADY\020\002\022\024\n\020READY_OPTIMIZING\020\003:b\352A_\n\037spann"
- + "er.googleapis.com/Database\022\202\323\344\223"
- + "\002/\022-/v1/{parent=projects/*/instances/*}/"
- + "databases\332A\006parent\022\244\002\n\016CreateDatabase\0227."
- + "google.spanner.admin.database.v1.CreateD"
- + "atabaseRequest\032\035.google.longrunning.Oper"
- + "ation\"\271\001\202\323\344\223\0022\"-/v1/{parent=projects/*/i"
- + "nstances/*}/databases:\001*\332A\027parent,create"
- + "_statement\312Ad\n)google.spanner.admin.data"
- + "base.v1.Database\0227google.spanner.admin.d"
- + "atabase.v1.CreateDatabaseMetadata\022\255\001\n\013Ge"
- + "tDatabase\0224.google.spanner.admin.databas"
- + "e.v1.GetDatabaseRequest\032*.google.spanner"
- + ".admin.database.v1.Database\"<\202\323\344\223\002/\022-/v1"
- + "/{name=projects/*/instances/*/databases/"
- + "*}\332A\004name\022\235\002\n\021UpdateDatabaseDdl\022:.google"
- + ".spanner.admin.database.v1.UpdateDatabas"
- + "eDdlRequest\032\035.google.longrunning.Operati"
- + "on\"\254\001\202\323\344\223\002:25/v1/{database=projects/*/in"
- + "stances/*/databases/*}/ddl:\001*\332A\023database"
- + ",statements\312AS\n\025google.protobuf.Empty\022:g"
- + "oogle.spanner.admin.database.v1.UpdateDa"
- + "tabaseDdlMetadata\022\243\001\n\014DropDatabase\0225.goo"
- + "gle.spanner.admin.database.v1.DropDataba"
- + "seRequest\032\026.google.protobuf.Empty\"D\202\323\344\223\002"
- + "3*1/v1/{database=projects/*/instances/*/"
- + "databases/*}\332A\010database\022\315\001\n\016GetDatabaseD"
- + "dl\0227.google.spanner.admin.database.v1.Ge"
- + "tDatabaseDdlRequest\0328.google.spanner.adm"
- + "in.database.v1.GetDatabaseDdlResponse\"H\202"
- + "\323\344\223\0027\0225/v1/{database=projects/*/instance"
- + "s/*/databases/*}/ddl\332A\010database\022\353\001\n\014SetI"
- + "amPolicy\022\".google.iam.v1.SetIamPolicyReq"
- + "uest\032\025.google.iam.v1.Policy\"\237\001\202\323\344\223\002\206\001\">/"
- + "v1/{resource=projects/*/instances/*/data"
- + "bases/*}:setIamPolicy:\001*ZA\"/v1"
- + "/{resource=projects/*/instances/*/databa"
- + "ses/*}:getIamPolicy:\001*ZA\".google.spanner.admi"
- + "n.database.v1.ListBackupOperationsRespon"
- + "se\"E\202\323\344\223\0026\0224/v1/{parent=projects/*/insta"
- + "nces/*}/backupOperations\332A\006parent\032x\312A\026sp"
- + "anner.googleapis.com\322A\\https://www.googl"
- + "eapis.com/auth/cloud-platform,https://ww"
- + "w.googleapis.com/auth/spanner.adminB\332\002\n$"
- + "com.google.spanner.admin.database.v1B\031Sp"
- + "annerDatabaseAdminProtoP\001ZHgoogle.golang"
- + ".org/genproto/googleapis/spanner/admin/d"
- + "atabase/v1;database\252\002&Google.Cloud.Spann"
- + "er.Admin.Database.V1\312\002&Google\\Cloud\\Span"
- + "ner\\Admin\\Database\\V1\352\002+Google::Cloud::S"
- + "panner::Admin::Database::V1\352AJ\n\037spanner."
- + "googleapis.com/Instance\022\'projects/{proje"
- + "ct}/instances/{instance}b\006proto3"
+ + ".database.v1.RestoreInfoB\003\340A\003\022%\n\030version"
+ + "_retention_period\030\006 \001(\tB\003\340A\003\022>\n\025earliest"
+ + "_version_time\030\007 \001(\0132\032.google.protobuf.Ti"
+ + "mestampB\003\340A\003\"M\n\005State\022\025\n\021STATE_UNSPECIFI"
+ + "ED\020\000\022\014\n\010CREATING\020\001\022\t\n\005READY\020\002\022\024\n\020READY_O"
+ + "PTIMIZING\020\003:b\352A_\n\037spanner.googleapis.com"
+ + "/Database\022\202\323\344\223\002/\022-/v1/{parent=proj"
+ + "ects/*/instances/*}/databases\332A\006parent\022\244"
+ + "\002\n\016CreateDatabase\0227.google.spanner.admin"
+ + ".database.v1.CreateDatabaseRequest\032\035.goo"
+ + "gle.longrunning.Operation\"\271\001\202\323\344\223\0022\"-/v1/"
+ + "{parent=projects/*/instances/*}/database"
+ + "s:\001*\332A\027parent,create_statement\312Ad\n)googl"
+ + "e.spanner.admin.database.v1.Database\0227go"
+ + "ogle.spanner.admin.database.v1.CreateDat"
+ + "abaseMetadata\022\255\001\n\013GetDatabase\0224.google.s"
+ + "panner.admin.database.v1.GetDatabaseRequ"
+ + "est\032*.google.spanner.admin.database.v1.D"
+ + "atabase\"<\202\323\344\223\002/\022-/v1/{name=projects/*/in"
+ + "stances/*/databases/*}\332A\004name\022\235\002\n\021Update"
+ + "DatabaseDdl\022:.google.spanner.admin.datab"
+ + "ase.v1.UpdateDatabaseDdlRequest\032\035.google"
+ + ".longrunning.Operation\"\254\001\202\323\344\223\002:25/v1/{da"
+ + "tabase=projects/*/instances/*/databases/"
+ + "*}/ddl:\001*\332A\023database,statements\312AS\n\025goog"
+ + "le.protobuf.Empty\022:google.spanner.admin."
+ + "database.v1.UpdateDatabaseDdlMetadata\022\243\001"
+ + "\n\014DropDatabase\0225.google.spanner.admin.da"
+ + "tabase.v1.DropDatabaseRequest\032\026.google.p"
+ + "rotobuf.Empty\"D\202\323\344\223\0023*1/v1/{database=pro"
+ + "jects/*/instances/*/databases/*}\332A\010datab"
+ + "ase\022\315\001\n\016GetDatabaseDdl\0227.google.spanner."
+ + "admin.database.v1.GetDatabaseDdlRequest\032"
+ + "8.google.spanner.admin.database.v1.GetDa"
+ + "tabaseDdlResponse\"H\202\323\344\223\0027\0225/v1/{database"
+ + "=projects/*/instances/*/databases/*}/ddl"
+ + "\332A\010database\022\353\001\n\014SetIamPolicy\022\".google.ia"
+ + "m.v1.SetIamPolicyRequest\032\025.google.iam.v1"
+ + ".Policy\"\237\001\202\323\344\223\002\206\001\">/v1/{resource=project"
+ + "s/*/instances/*/databases/*}:setIamPolic"
+ + "y:\001*ZA\"/v1/{resource=projects/"
+ + "*/instances/*/databases/*}:getIamPolicy:"
+ + "\001*ZA\""
+ + ".google.spanner.admin.database.v1.ListBa"
+ + "ckupOperationsResponse\"E\202\323\344\223\0026\0224/v1/{par"
+ + "ent=projects/*/instances/*}/backupOperat"
+ + "ions\332A\006parent\032x\312A\026spanner.googleapis.com"
+ + "\322A\\https://www.googleapis.com/auth/cloud"
+ + "-platform,https://www.googleapis.com/aut"
+ + "h/spanner.adminB\332\002\n$com.google.spanner.a"
+ + "dmin.database.v1B\031SpannerDatabaseAdminPr"
+ + "otoP\001ZHgoogle.golang.org/genproto/google"
+ + "apis/spanner/admin/database/v1;database\252"
+ + "\002&Google.Cloud.Spanner.Admin.Database.V1"
+ + "\312\002&Google\\Cloud\\Spanner\\Admin\\Database\\V"
+ + "1\352\002+Google::Cloud::Spanner::Admin::Datab"
+ + "ase::V1\352AJ\n\037spanner.googleapis.com/Insta"
+ + "nce\022\'projects/{project}/instances/{insta"
+ + "nce}b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
@@ -321,7 +326,12 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
new com.google.protobuf.GeneratedMessageV3.FieldAccessorTable(
internal_static_google_spanner_admin_database_v1_Database_descriptor,
new java.lang.String[] {
- "Name", "State", "CreateTime", "RestoreInfo",
+ "Name",
+ "State",
+ "CreateTime",
+ "RestoreInfo",
+ "VersionRetentionPeriod",
+ "EarliestVersionTime",
});
internal_static_google_spanner_admin_database_v1_ListDatabasesRequest_descriptor =
getDescriptor().getMessageTypes().get(2);
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/backup.proto b/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/backup.proto
index e33faddddf4..a677207f729 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/backup.proto
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/backup.proto
@@ -61,6 +61,12 @@ message Backup {
type: "spanner.googleapis.com/Database"
}];
+ // The backup will contain an externally consistent copy of the database at
+ // the timestamp specified by `version_time`. If `version_time` is not
+ // specified, the system will set `version_time` to the `create_time` of the
+ // backup.
+ google.protobuf.Timestamp version_time = 9;
+
// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
// operation. The expiration time of the backup, with microseconds
// granularity that must be at least 6 hours and at most 366 days
@@ -84,10 +90,9 @@ message Backup {
// `projects//instances/`.
string name = 1;
- // Output only. The backup will contain an externally consistent
- // copy of the database at the timestamp specified by
- // `create_time`. `create_time` is approximately the time the
- // [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
+ // Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
+ // request is received. If the request does not specify `version_time`, the
+ // `version_time` of the backup will be equivalent to the `create_time`.
google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Size of the backup in bytes.
@@ -134,10 +139,14 @@ message CreateBackupRequest {
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
message CreateBackupMetadata {
// The name of the backup being created.
- string name = 1;
+ string name = 1 [(google.api.resource_reference) = {
+ type: "spanner.googleapis.com/Backup"
+ }];
// The name of the database the backup is created from.
- string database = 2;
+ string database = 2 [(google.api.resource_reference) = {
+ type: "spanner.googleapis.com/Database"
+ }];
// The progress of the
// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
@@ -311,9 +320,9 @@ message ListBackupOperationsRequest {
// * `done:true` - The operation is complete.
// * `metadata.database:prod` - The database the backup was taken from has
// a name containing the string "prod".
- // * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND`
- // `(metadata.name:howl) AND`
- // `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
+ // * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
+ // `(metadata.name:howl) AND` \
+ // `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
// `(error:*)` - Returns operations where:
// * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
// * The backup name contains the string "howl".
@@ -355,12 +364,23 @@ message ListBackupOperationsResponse {
// Information about a backup.
message BackupInfo {
// Name of the backup.
- string backup = 1;
+ string backup = 1 [(google.api.resource_reference) = {
+ type: "spanner.googleapis.com/Backup"
+ }];
// The backup contains an externally consistent copy of `source_database` at
- // the timestamp specified by `create_time`.
+ // the timestamp specified by `version_time`. If the
+ // [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
+ // `version_time`, the `version_time` of the backup is equivalent to the
+ // `create_time`.
+ google.protobuf.Timestamp version_time = 4;
+
+ // The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
+ // received.
google.protobuf.Timestamp create_time = 2;
// Name of the database the backup was created from.
- string source_database = 3;
+ string source_database = 3 [(google.api.resource_reference) = {
+ type: "spanner.googleapis.com/Database"
+ }];
}
diff --git a/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/spanner_database_admin.proto b/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/spanner_database_admin.proto
index db6192bc026..12e751bd672 100644
--- a/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/spanner_database_admin.proto
+++ b/proto-google-cloud-spanner-admin-database-v1/src/main/proto/google/spanner/admin/database/v1/spanner_database_admin.proto
@@ -368,6 +368,17 @@ message Database {
// Output only. Applicable only for restored databases. Contains information
// about the restore source.
RestoreInfo restore_info = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. The period in which Cloud Spanner retains all versions of data
+ // for the database. This is the same as the value of version_retention_period
+ // database option set using
+ // [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
+ // if not set.
+ string version_retention_period = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Output only. Earliest timestamp at which older versions of the data can be
+ // read.
+ google.protobuf.Timestamp earliest_version_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
@@ -535,6 +546,8 @@ message DropDatabaseRequest {
// The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
message GetDatabaseDdlRequest {
// Required. The database whose schema we wish to get.
+ // Values are of the form
+ // `projects//instances//databases/`
string database = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@@ -590,11 +603,11 @@ message ListDatabaseOperationsRequest {
// Here are a few examples:
//
// * `done:true` - The operation is complete.
- // * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND`
- // `(metadata.source_type:BACKUP) AND`
- // `(metadata.backup_info.backup:backup_howl) AND`
- // `(metadata.name:restored_howl) AND`
- // `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
+ // * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+ // `(metadata.source_type:BACKUP) AND` \
+ // `(metadata.backup_info.backup:backup_howl) AND` \
+ // `(metadata.name:restored_howl) AND` \
+ // `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
// `(error:*)` - Return operations where:
// * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
// * The database is restored from a backup.
@@ -666,7 +679,9 @@ message RestoreDatabaseRequest {
// [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
message RestoreDatabaseMetadata {
// Name of the database being created and restored to.
- string name = 1;
+ string name = 1 [(google.api.resource_reference) = {
+ type: "spanner.googleapis.com/Database"
+ }];
// The type of the restore source.
RestoreSourceType source_type = 2;
@@ -716,7 +731,9 @@ message RestoreDatabaseMetadata {
// completion of a database restore, and cannot be cancelled.
message OptimizeRestoredDatabaseMetadata {
// Name of the restored database being optimized.
- string name = 1;
+ string name = 1 [(google.api.resource_reference) = {
+ type: "spanner.googleapis.com/Database"
+ }];
// The progress of the post-restore optimizations.
OperationProgress progress = 2;
diff --git a/synth.metadata b/synth.metadata
index d9eb2060851..383b16ed68b 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -11,8 +11,8 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
- "sha": "8fa381b7138f1d72966ff20563efae1b2194d359",
- "internalRef": "353145174"
+ "sha": "30eb779ddcc4f389df34d0802d081ef6c4559d6d",
+ "internalRef": "354462069"
}
},
{
From 61ea2b940cadab8952900b3465ac5bf24f1c47f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Mon, 1 Feb 2021 11:06:03 +0100
Subject: [PATCH 19/42] test: reduce wait time for BackendExhaustedTest (#835)
The BackendExhaustedTest deliberately causes requests to get stuck on the mock server. This causes the Spanner instance to refuse to shutdown nicely and causes it to wait for 10 seconds. This can be circumvented by using shutdownNow() to force the closure of all gRPC transport channels. This reduces the overall build time with approx 10 seconds.
---
.../com/google/cloud/spanner/SpannerImpl.java | 7 ++++++-
.../cloud/spanner/spi/v1/GapicSpannerRpc.java | 16 ++++++++++++++++
.../cloud/spanner/BackendExhaustedTest.java | 3 +--
3 files changed, 23 insertions(+), 3 deletions(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java
index 2d034eda883..9fa8b30be28 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java
@@ -25,6 +25,7 @@
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.spanner.SessionClient.SessionId;
import com.google.cloud.spanner.SpannerOptions.CloseableExecutorProvider;
+import com.google.cloud.spanner.spi.v1.GapicSpannerRpc;
import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.cloud.spanner.spi.v1.SpannerRpc.Paginated;
import com.google.common.annotations.VisibleForTesting;
@@ -269,7 +270,11 @@ void close(long timeout, TimeUnit unit) {
sessionClients.clear();
asyncExecutorProvider.close();
try {
- gapicRpc.shutdown();
+ if (timeout == Long.MAX_VALUE || !(gapicRpc instanceof GapicSpannerRpc)) {
+ gapicRpc.shutdown();
+ } else {
+ ((GapicSpannerRpc) gapicRpc).shutdownNow();
+ }
} catch (RuntimeException e) {
logger.log(Level.WARNING, "Failed to close channels", e);
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java
index 5172fe448fb..807eac6f11b 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java
@@ -1718,6 +1718,22 @@ public void shutdown() {
}
}
+ public void shutdownNow() {
+ this.rpcIsClosed = true;
+ this.spannerStub.close();
+ this.partitionedDmlStub.close();
+ this.instanceAdminStub.close();
+ this.databaseAdminStub.close();
+ this.spannerWatchdog.shutdown();
+ this.executorProvider.shutdown();
+
+ this.spannerStub.shutdownNow();
+ this.partitionedDmlStub.shutdownNow();
+ this.instanceAdminStub.shutdownNow();
+ this.databaseAdminStub.shutdownNow();
+ this.spannerWatchdog.shutdownNow();
+ }
+
@Override
public boolean isClosed() {
return rpcIsClosed;
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BackendExhaustedTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BackendExhaustedTest.java
index cb1244f8e3e..7e4e41facc0 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BackendExhaustedTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/BackendExhaustedTest.java
@@ -136,7 +136,6 @@ public void setUp() throws Exception {
SessionPoolOptions.newBuilder()
.setMinSessions(executor.getCorePoolSize())
.setMaxSessions(executor.getCorePoolSize() * 3)
- .setWriteSessionsFraction(0.0f)
.build())
.build();
executorFactory.release(executor);
@@ -159,7 +158,7 @@ public void tearDown() {
// This test case force-closes the Spanner instance as it would otherwise wait
// forever on the BatchCreateSessions requests that are 'stuck'.
try {
- ((SpannerImpl) spanner).close(100L, TimeUnit.MILLISECONDS);
+ ((SpannerImpl) spanner).close(10L, TimeUnit.MILLISECONDS);
} catch (SpannerException e) {
// ignore any errors during close as they are expected.
}
From 1c4eead835c455b9bb04dc3d0aab7a230375760e Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Mon, 1 Feb 2021 19:02:15 -0800
Subject: [PATCH 20/42] build: migrate to flakybot (#839)
Source-Author: Justin Beckwith
Source-Date: Thu Jan 28 22:22:38 2021 -0800
Source-Repo: googleapis/synthtool
Source-Sha: d1bb9173100f62c0cfc8f3138b62241e7f47ca6a
Source-Link: https://github.com/googleapis/synthtool/commit/d1bb9173100f62c0cfc8f3138b62241e7f47ca6a
---
.kokoro/build.sh | 4 ++--
synth.metadata | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/.kokoro/build.sh b/.kokoro/build.sh
index 8280d10ad67..4572da72d57 100755
--- a/.kokoro/build.sh
+++ b/.kokoro/build.sh
@@ -110,8 +110,8 @@ bash .kokoro/coerce_logs.sh
if [[ "${ENABLE_BUILD_COP}" == "true" ]]
then
- chmod +x ${KOKORO_GFILE_DIR}/linux_amd64/buildcop
- ${KOKORO_GFILE_DIR}/linux_amd64/buildcop -repo=googleapis/java-spanner
+ chmod +x ${KOKORO_GFILE_DIR}/linux_amd64/flakybot
+ ${KOKORO_GFILE_DIR}/linux_amd64/flakybot -repo=googleapis/java-spanner
fi
echo "exiting with ${RETURN_CODE}"
diff --git a/synth.metadata b/synth.metadata
index 383b16ed68b..3ab9fe79bde 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "facda8a7d07a9cf08b1847678b24b270f1abdb38"
+ "sha": "004c5d759804a380e65d1023faef0978de5d3ff9"
}
},
{
@@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "3816b080296d4d52975079fd26c110dd26ba25af"
+ "sha": "d1bb9173100f62c0cfc8f3138b62241e7f47ca6a"
}
}
],
From 77b7cfcd1b2cc4825e226f219900f8eab29732df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Tue, 2 Feb 2021 04:24:24 +0100
Subject: [PATCH 21/42] test: suppress logging a known warning (#841)
---
.../cloud/spanner/connection/SpannerPoolTest.java | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java
index 19d6dfddcde..9174ef81b22 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java
@@ -169,6 +169,7 @@ public void testRemoveConnection() {
private static Logger log = Logger.getLogger(SpannerPool.class.getName());
private static OutputStream logCapturingStream;
private static StreamHandler customLogHandler;
+ private static boolean useParentHandlers;
private void attachLogCapturer() {
logCapturingStream = new ByteArrayOutputStream();
@@ -182,14 +183,23 @@ private void attachLogCapturer() {
throw new IllegalStateException("no handlers found for logger");
}
customLogHandler = new StreamHandler(logCapturingStream, handlers[0].getFormatter());
+ useParentHandlers = log.getUseParentHandlers();
+ log.setUseParentHandlers(false);
log.addHandler(customLogHandler);
}
- public String getTestCapturedLog() {
+ private String getTestCapturedLog() {
customLogHandler.flush();
return logCapturingStream.toString();
}
+ @AfterClass
+ public static void resetUseParentHandlers() {
+ if (useParentHandlers) {
+ log.setUseParentHandlers(true);
+ }
+ }
+
@Test
public void testRemoveConnectionOptionsNotRegistered() {
attachLogCapturer();
From 118d1b31f5f7771023766fd72a8229db80f1f5a2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Tue, 2 Feb 2021 04:28:36 +0100
Subject: [PATCH 22/42] fix: make compiled statements immutable (#843)
---
.../ClientSideStatementExecutor.java | 13 -------------
.../connection/ClientSideStatementImpl.java | 11 +++++++----
.../ClientSideStatementNoParamExecutor.java | 14 +++++++++-----
.../ClientSideStatementSetExecutor.java | 18 ++++++++++++------
4 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementExecutor.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementExecutor.java
index 24681939187..7ec09766697 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementExecutor.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementExecutor.java
@@ -16,8 +16,6 @@
package com.google.cloud.spanner.connection;
-import com.google.cloud.spanner.connection.ClientSideStatementImpl.CompileException;
-
/**
* A {@link ClientSideStatementExecutor} is used to compile {@link ClientSideStatement}s from the
* json source file, and to execute these against a {@link Connection} (through a {@link
@@ -25,17 +23,6 @@
*/
interface ClientSideStatementExecutor {
- /**
- * Compiles the given {@link ClientSideStatementImpl} and registers this statement with this
- * executor. A statement must be compiled before it can be executed. The parser automatically
- * compiles all available statements during initialization.
- *
- * @param statement The statement to compile.
- * @throws CompileException If the statement could not be compiled. This should never happen, as
- * it would indicate that an invalid statement has been defined in the source file.
- */
- void compile(ClientSideStatementImpl statement) throws CompileException;
-
/**
* Executes the {@link ClientSideStatementImpl} that has been compiled and registered with this
* executor on the specified connection.
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementImpl.java
index 7621a0ced5c..e9c9c1654e9 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementImpl.java
@@ -19,6 +19,7 @@
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.connection.StatementResult.ResultType;
import com.google.common.base.Preconditions;
+import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.Collections;
import java.util.List;
@@ -143,10 +144,12 @@ public String getMessage() {
ClientSideStatementImpl compile() throws CompileException {
try {
this.pattern = Pattern.compile(regex);
- this.executor =
- (ClientSideStatementExecutor)
- Class.forName(getClass().getPackage().getName() + "." + executorName).newInstance();
- this.executor.compile(this);
+ @SuppressWarnings("unchecked")
+ Constructor constructor =
+ (Constructor)
+ Class.forName(getClass().getPackage().getName() + "." + executorName)
+ .getDeclaredConstructor(ClientSideStatementImpl.class);
+ this.executor = constructor.newInstance(this);
return this;
} catch (Exception e) {
throw new CompileException(e, this);
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementNoParamExecutor.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementNoParamExecutor.java
index 4c31e3e28d2..6f5e683ce64 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementNoParamExecutor.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementNoParamExecutor.java
@@ -24,12 +24,16 @@
* SHOW AUTOCOMMIT. The executor just calls a method with no parameters.
*/
class ClientSideStatementNoParamExecutor implements ClientSideStatementExecutor {
- private Method method;
+ private final Method method;
- ClientSideStatementNoParamExecutor() {}
-
- @Override
- public void compile(ClientSideStatementImpl statement) throws CompileException {
+ /**
+ * Creates and compiles the given {@link ClientSideStatementImpl}.
+ *
+ * @param statement The statement to compile.
+ * @throws CompileException If the statement could not be compiled. This should never happen, as
+ * it would indicate that an invalid statement has been defined in the source file.
+ */
+ ClientSideStatementNoParamExecutor(ClientSideStatementImpl statement) throws CompileException {
try {
this.method = ConnectionStatementExecutor.class.getDeclaredMethod(statement.getMethodName());
} catch (NoSuchMethodException | SecurityException e) {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementSetExecutor.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementSetExecutor.java
index 54765282f5c..4f4fe140428 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementSetExecutor.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ClientSideStatementSetExecutor.java
@@ -30,14 +30,20 @@
* AUTOCOMMIT=TRUE.
*/
class ClientSideStatementSetExecutor implements ClientSideStatementExecutor {
- private ClientSideStatementImpl statement;
- private Method method;
- private ClientSideStatementValueConverter converter;
- private Pattern allowedValuesPattern;
+ private final ClientSideStatementImpl statement;
+ private final Method method;
+ private final ClientSideStatementValueConverter converter;
+ private final Pattern allowedValuesPattern;
+ /**
+ * Creates and compiles the given {@link ClientSideStatementImpl}.
+ *
+ * @param statement The statement to compile.
+ * @throws CompileException If the statement could not be compiled. This should never happen, as
+ * it would indicate that an invalid statement has been defined in the source file.
+ */
@SuppressWarnings("unchecked")
- @Override
- public void compile(ClientSideStatementImpl statement) throws CompileException {
+ ClientSideStatementSetExecutor(ClientSideStatementImpl statement) throws CompileException {
Preconditions.checkNotNull(statement.getSetStatement());
try {
this.statement = statement;
From 2c745f31288d5f6ad501b5542ea01db72e015d1e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Tue, 2 Feb 2021 04:29:16 +0100
Subject: [PATCH 23/42] cleanup: return instead of fallthrough + improve
comment (#844)
Return the TransactionSelector that is built instead of falling through to the end of
the method. The behavior does not change by this, but it makes it easier to read and
understand the code.
Fixes #830
---
.../java/com/google/cloud/spanner/TransactionRunnerImpl.java | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
index c3973c1807d..a4973c29345 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
@@ -463,7 +463,10 @@ TransactionSelector getTransactionSelector() {
// Aborted error if the call that included the BeginTransaction option fails. The
// Aborted error will cause the entire transaction to be retried, and the retry will use
// a separate BeginTransaction RPC.
- TransactionSelector.newBuilder()
+ // If tx.get() returns successfully, this.transactionId will also have been set to a
+ // valid value as the latter is always set when a transaction id is returned by a
+ // statement.
+ return TransactionSelector.newBuilder()
.setId(tx.get(waitForTransactionTimeoutMillis, TimeUnit.MILLISECONDS))
.build();
}
From f9ac29cd05e775c8ea17e0e227eb925df88a8dba Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Tue, 2 Feb 2021 14:12:03 -0800
Subject: [PATCH 24/42] build(java): generate docfx yml on release (#845)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6670e800-5ae0-42a0-9f59-45848d8d694a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/5de29e9434b63ea6d7e46dc348521c62969af1a1
---
.kokoro/release/publish_javadoc.cfg | 5 +--
.kokoro/release/publish_javadoc11.cfg | 30 +++++++++++++++
.kokoro/release/publish_javadoc11.sh | 55 +++++++++++++++++++++++++++
synth.metadata | 6 ++-
4 files changed, 90 insertions(+), 6 deletions(-)
create mode 100644 .kokoro/release/publish_javadoc11.cfg
create mode 100755 .kokoro/release/publish_javadoc11.sh
diff --git a/.kokoro/release/publish_javadoc.cfg b/.kokoro/release/publish_javadoc.cfg
index e41d593e948..cbde2338f3d 100644
--- a/.kokoro/release/publish_javadoc.cfg
+++ b/.kokoro/release/publish_javadoc.cfg
@@ -26,7 +26,4 @@ before_action {
keyname: "docuploader_service_account"
}
}
-}
-
-# Downloads docfx doclet resource. This will be in ${KOKORO_GFILE_DIR}/
-gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/docfx"
\ No newline at end of file
+}
\ No newline at end of file
diff --git a/.kokoro/release/publish_javadoc11.cfg b/.kokoro/release/publish_javadoc11.cfg
new file mode 100644
index 00000000000..2ddd71ce63e
--- /dev/null
+++ b/.kokoro/release/publish_javadoc11.cfg
@@ -0,0 +1,30 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+ key: "STAGING_BUCKET_V2"
+ value: "docs-staging-v2"
+ # Production will be at: docs-staging-v2
+}
+
+# Configure the docker image for kokoro-trampoline
+env_vars: {
+ key: "TRAMPOLINE_IMAGE"
+ value: "gcr.io/cloud-devrel-kokoro-resources/java11"
+}
+
+env_vars: {
+ key: "TRAMPOLINE_BUILD_FILE"
+ value: "github/java-memcache/.kokoro/release/publish_javadoc11.sh"
+}
+
+before_action {
+ fetch_keystore {
+ keystore_resource {
+ keystore_config_id: 73713
+ keyname: "docuploader_service_account"
+ }
+ }
+}
+
+# Downloads docfx doclet resource. This will be in ${KOKORO_GFILE_DIR}/
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/docfx"
\ No newline at end of file
diff --git a/.kokoro/release/publish_javadoc11.sh b/.kokoro/release/publish_javadoc11.sh
new file mode 100755
index 00000000000..63af49cf0da
--- /dev/null
+++ b/.kokoro/release/publish_javadoc11.sh
@@ -0,0 +1,55 @@
+#!/bin/bash
+# Copyright 2021 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.
+
+set -eo pipefail
+
+if [[ -z "${CREDENTIALS}" ]]; then
+ CREDENTIALS=${KOKORO_KEYSTORE_DIR}/73713_docuploader_service_account
+fi
+
+if [[ -z "${STAGING_BUCKET_V2}" ]]; then
+ echo "Need to set STAGING_BUCKET_V2 environment variable"
+ exit 1
+fi
+
+# work from the git root directory
+pushd $(dirname "$0")/../../
+
+# install docuploader package
+python3 -m pip install gcp-docuploader
+
+# compile all packages
+mvn clean install -B -q -DskipTests=true
+
+export NAME=google-cloud-spanner
+export VERSION=$(grep ${NAME}: versions.txt | cut -d: -f3)
+
+# V3 generates docfx yml from javadoc
+# generate yml
+mvn clean site -B -q -P docFX
+
+pushd target/docfx-yml
+
+# create metadata
+python3 -m docuploader create-metadata \
+ --name ${NAME} \
+ --version ${VERSION} \
+ --language java
+
+# upload yml
+python3 -m docuploader upload . \
+ --credentials ${CREDENTIALS} \
+ --staging-bucket ${STAGING_BUCKET_V2} \
+ --destination-prefix docfx-
diff --git a/synth.metadata b/synth.metadata
index 3ab9fe79bde..7d46ad4dc0b 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "004c5d759804a380e65d1023faef0978de5d3ff9"
+ "sha": "2c745f31288d5f6ad501b5542ea01db72e015d1e"
}
},
{
@@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "d1bb9173100f62c0cfc8f3138b62241e7f47ca6a"
+ "sha": "5de29e9434b63ea6d7e46dc348521c62969af1a1"
}
}
],
@@ -102,6 +102,8 @@
".kokoro/release/promote.sh",
".kokoro/release/publish_javadoc.cfg",
".kokoro/release/publish_javadoc.sh",
+ ".kokoro/release/publish_javadoc11.cfg",
+ ".kokoro/release/publish_javadoc11.sh",
".kokoro/release/snapshot.cfg",
".kokoro/release/snapshot.sh",
".kokoro/release/stage.cfg",
From 2887bbb77141ddc92d8ef79d6221a041b4330999 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Thu, 4 Feb 2021 12:54:10 -0800
Subject: [PATCH 25/42] build(java): run linkage monitor as GitHub action
(#846)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/5d05a436-b3b3-491d-bbf9-6b053be3c812/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/e935c9ecb47da0f2e054f5f1845f7cf7c95fa625
---
.github/workflows/ci.yaml | 13 ++++++++++-
.kokoro/linkage-monitor.sh | 46 --------------------------------------
synth.metadata | 5 ++---
3 files changed, 14 insertions(+), 50 deletions(-)
delete mode 100755 .kokoro/linkage-monitor.sh
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 68302207566..98a472e132d 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -54,7 +54,18 @@ jobs:
with:
java-version: 8
- run: java -version
- - run: .kokoro/linkage-monitor.sh
+ - name: Install artifacts to local Maven repository
+ run: |
+ source .kokoro/common.sh
+ retry_with_backoff 3 10 \
+ mvn install -B -V \
+ -Dmaven.test.skip -DskipTests=true \
+ -Dclirr.skip=true \
+ -Denforcer.skip=true \
+ -Dmaven.javadoc.skip=true \
+ -Dgcloud.download.skip=true
+ shell: bash
+ - uses: GoogleCloudPlatform/cloud-opensource-java/linkage-monitor@v1-linkagemonitor
lint:
runs-on: ubuntu-latest
steps:
diff --git a/.kokoro/linkage-monitor.sh b/.kokoro/linkage-monitor.sh
deleted file mode 100755
index 759ab4e2c22..00000000000
--- a/.kokoro/linkage-monitor.sh
+++ /dev/null
@@ -1,46 +0,0 @@
-#!/bin/bash
-# Copyright 2019 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.
-
-set -eo pipefail
-# Display commands being run.
-set -x
-
-## Get the directory of the build script
-scriptDir=$(realpath $(dirname "${BASH_SOURCE[0]}"))
-## cd to the parent directory, i.e. the root of the git repo
-cd ${scriptDir}/..
-
-# include common functions
-source ${scriptDir}/common.sh
-
-# Print out Java version
-java -version
-echo ${JOB_TYPE}
-
-# attempt to install 3 times with exponential backoff (starting with 10 seconds)
-retry_with_backoff 3 10 \
- mvn install -B -V \
- -DskipTests=true \
- -Dclirr.skip=true \
- -Denforcer.skip=true \
- -Dmaven.javadoc.skip=true \
- -Dgcloud.download.skip=true
-
-# Kokoro job cloud-opensource-java/ubuntu/linkage-monitor-gcs creates this JAR
-JAR=linkage-monitor-latest-all-deps.jar
-curl -v -O "https://storage.googleapis.com/cloud-opensource-java-linkage-monitor/${JAR}"
-
-# Fails if there's new linkage errors compared with baseline
-java -jar ${JAR} com.google.cloud:libraries-bom
diff --git a/synth.metadata b/synth.metadata
index 7d46ad4dc0b..a25f31efdaa 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "2c745f31288d5f6ad501b5542ea01db72e015d1e"
+ "sha": "f9ac29cd05e775c8ea17e0e227eb925df88a8dba"
}
},
{
@@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "5de29e9434b63ea6d7e46dc348521c62969af1a1"
+ "sha": "e935c9ecb47da0f2e054f5f1845f7cf7c95fa625"
}
}
],
@@ -74,7 +74,6 @@
".kokoro/continuous/java8.cfg",
".kokoro/continuous/readme.cfg",
".kokoro/dependencies.sh",
- ".kokoro/linkage-monitor.sh",
".kokoro/nightly/integration.cfg",
".kokoro/nightly/java11.cfg",
".kokoro/nightly/java7.cfg",
From 1d5f71cd3c4fce60846bfaa8b055acffbc119810 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Thu, 4 Feb 2021 15:32:22 -0800
Subject: [PATCH 26/42] chore: Re-generated to pick up changes from synthtool.
(#851)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b107ca23-cc03-4d8e-82d2-0b35f1361777/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/692715c0f23a7bb3bfbbaa300f7620ddfa8c47e5
Source-Link: https://github.com/googleapis/synthtool/commit/27b2d4f4674840628d0b75c5941e89c12af4764f
Source-Link: https://github.com/googleapis/synthtool/commit/140ba24a136c63e7f10a998a63e7898aed63ea7d
---
.github/workflows/auto-release.yaml | 2 +-
.kokoro/release/publish_javadoc11.cfg | 4 ++--
LICENSE | 1 -
synth.metadata | 4 ++--
4 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/auto-release.yaml b/.github/workflows/auto-release.yaml
index 2b6cdbc976c..76e6404b4e0 100644
--- a/.github/workflows/auto-release.yaml
+++ b/.github/workflows/auto-release.yaml
@@ -17,7 +17,7 @@ jobs:
}
// only approve PRs like "chore: release "
- if ( !context.payload.pull_request.title.startsWith("chore: release") ) {
+ if ( !context.payload.pull_request.title.startsWith("chore(master): release") ) {
return;
}
diff --git a/.kokoro/release/publish_javadoc11.cfg b/.kokoro/release/publish_javadoc11.cfg
index 2ddd71ce63e..02cd9b1ccff 100644
--- a/.kokoro/release/publish_javadoc11.cfg
+++ b/.kokoro/release/publish_javadoc11.cfg
@@ -14,7 +14,7 @@ env_vars: {
env_vars: {
key: "TRAMPOLINE_BUILD_FILE"
- value: "github/java-memcache/.kokoro/release/publish_javadoc11.sh"
+ value: "github/java-spanner/.kokoro/release/publish_javadoc11.sh"
}
before_action {
@@ -27,4 +27,4 @@ before_action {
}
# Downloads docfx doclet resource. This will be in ${KOKORO_GFILE_DIR}/
-gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/docfx"
\ No newline at end of file
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/docfx"
diff --git a/LICENSE b/LICENSE
index d6456956733..261eeb9e9f8 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,3 @@
-
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
diff --git a/synth.metadata b/synth.metadata
index a25f31efdaa..7e28947f74e 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "f9ac29cd05e775c8ea17e0e227eb925df88a8dba"
+ "sha": "2887bbb77141ddc92d8ef79d6221a041b4330999"
}
},
{
@@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "e935c9ecb47da0f2e054f5f1845f7cf7c95fa625"
+ "sha": "692715c0f23a7bb3bfbbaa300f7620ddfa8c47e5"
}
}
],
From 58cebd85a9d82bd1526b9eae98892181f1a022f1 Mon Sep 17 00:00:00 2001
From: WhiteSource Renovate
Date: Mon, 8 Feb 2021 03:12:52 +0100
Subject: [PATCH 27/42] deps: update dependency
com.google.cloud:google-cloud-monitoring to v2.0.12 (#854)
---
samples/install-without-bom/pom.xml | 2 +-
samples/snapshot/pom.xml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/samples/install-without-bom/pom.xml b/samples/install-without-bom/pom.xml
index 8658f8208b0..5373c065550 100644
--- a/samples/install-without-bom/pom.xml
+++ b/samples/install-without-bom/pom.xml
@@ -23,7 +23,7 @@
UTF-8
0.28.3
1.2.11
- 2.0.11
+ 2.0.12
diff --git a/samples/snapshot/pom.xml b/samples/snapshot/pom.xml
index 93f5eff505b..e66974d9002 100644
--- a/samples/snapshot/pom.xml
+++ b/samples/snapshot/pom.xml
@@ -23,7 +23,7 @@
UTF-8
0.28.3
1.2.11
- 2.0.11
+ 2.0.12
From c451f86af5dade8653356bc30436199db9328061 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Tue, 9 Feb 2021 02:14:06 +0100
Subject: [PATCH 28/42] cleanup: remove unused transaction manager (#858)
The SingleUseTransaction in the Connection API previously used a
TransactionManager instead of a TransactionRunner, as this was the only way that it
was possible to implement a statement-specific timeout. This is now supported by the
client library, and the SingleUseTransaction had already been moved to using only a
TransactionRunner. There was however still an unused TransactionManager reference in
the code.
Fixes #852
---
.../spanner/connection/SingleUseTransaction.java | 16 +++-------------
1 file changed, 3 insertions(+), 13 deletions(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SingleUseTransaction.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SingleUseTransaction.java
index 52011eb9100..edabb7f0177 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SingleUseTransaction.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SingleUseTransaction.java
@@ -33,7 +33,6 @@
import com.google.cloud.spanner.Statement;
import com.google.cloud.spanner.TimestampBound;
import com.google.cloud.spanner.TransactionContext;
-import com.google.cloud.spanner.TransactionManager;
import com.google.cloud.spanner.TransactionRunner;
import com.google.cloud.spanner.TransactionRunner.TransactionCallable;
import com.google.cloud.spanner.connection.StatementParser.ParsedStatement;
@@ -71,7 +70,6 @@ class SingleUseTransaction extends AbstractBaseUnitOfWork {
private final TimestampBound readOnlyStaleness;
private final AutocommitDmlMode autocommitDmlMode;
private volatile SettableApiFuture readTimestamp = null;
- private volatile TransactionManager txManager;
private volatile TransactionRunner writeTransaction;
private boolean used = false;
private volatile UnitOfWorkState state = UnitOfWorkState.STARTED;
@@ -221,29 +219,21 @@ public Timestamp getReadTimestampOrNull() {
}
private boolean hasCommitTimestamp() {
- return state == UnitOfWorkState.COMMITTED
- && (writeTransaction != null
- || (txManager != null
- && txManager.getState()
- == com.google.cloud.spanner.TransactionManager.TransactionState.COMMITTED));
+ return state == UnitOfWorkState.COMMITTED && writeTransaction != null;
}
@Override
public Timestamp getCommitTimestamp() {
ConnectionPreconditions.checkState(
hasCommitTimestamp(), "There is no commit timestamp available for this transaction.");
- return writeTransaction != null
- ? writeTransaction.getCommitTimestamp()
- : txManager.getCommitTimestamp();
+ return writeTransaction.getCommitTimestamp();
}
@Override
public Timestamp getCommitTimestampOrNull() {
if (hasCommitTimestamp()) {
try {
- return writeTransaction != null
- ? writeTransaction.getCommitTimestamp()
- : txManager.getCommitTimestamp();
+ return writeTransaction.getCommitTimestamp();
} catch (SpannerException e) {
// ignore
}
From c86fb5e24459f4d4b3d5c2ceda55c0bbe2cacabc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Tue, 9 Feb 2021 02:21:19 +0100
Subject: [PATCH 29/42] test: force-close to speed up timeout tests (#840)
* test: force-close to speed up timeout tests
* fix: mark connection as closed before waiting
* fix: set closed before shutting down
* cleanup: add test cases + remove unused code
---
.../spanner/connection/ConnectionImpl.java | 12 ++++--
.../cloud/spanner/connection/SpannerPool.java | 34 +++++++++++-----
.../spanner/connection/StatementExecutor.java | 8 ++++
.../spanner/ForceCloseSpannerFunction.java | 40 +++++++++++++++++++
.../connection/AbstractMockServerTest.java | 17 ++++++--
.../spanner/connection/SpannerPoolTest.java | 15 ++++---
6 files changed, 106 insertions(+), 20 deletions(-)
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/ForceCloseSpannerFunction.java
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
index b49adbf1245..0c91e8060e7 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionImpl.java
@@ -259,11 +259,17 @@ public void close() {
// Ignore as we are closing the connection.
}
}
- statementExecutor.shutdownNow();
- spannerPool.removeConnection(options, this);
+ // Try to wait for the current statement to finish (if any) before we actually close the
+ // connection.
+ this.closed = true;
+ statementExecutor.shutdown();
leakedException = null;
+ spannerPool.removeConnection(options, this);
+ statementExecutor.awaitTermination(10L, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {
+ // ignore and continue to close the connection.
} finally {
- this.closed = true;
+ statementExecutor.shutdownNow();
}
}
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java
index be5b16e393b..51bfde8f00e 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java
@@ -25,6 +25,7 @@
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Function;
import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import com.google.common.base.Predicates;
@@ -62,6 +63,15 @@ public class SpannerPool {
private static final String CONNECTION_API_CLIENT_LIB_TOKEN = "sp-jdbc";
private static final Logger logger = Logger.getLogger(SpannerPool.class.getName());
+ private static final Function DEFAULT_CLOSE_FUNCTION =
+ new Function() {
+ @Override
+ public Void apply(Spanner spanner) {
+ spanner.close();
+ return null;
+ }
+ };
+
/**
* Closes the default {@link SpannerPool} and all {@link Spanner} instances that have been opened
* by connections and that are still open. Call this method at the end of your application to
@@ -395,6 +405,12 @@ void checkAndCloseSpanners() {
@VisibleForTesting
void checkAndCloseSpanners(CheckAndCloseSpannersMode mode) {
+ checkAndCloseSpanners(mode, DEFAULT_CLOSE_FUNCTION);
+ }
+
+ @VisibleForTesting
+ void checkAndCloseSpanners(
+ CheckAndCloseSpannersMode mode, Function closeSpannerFunction) {
List keysStillInUse = new ArrayList<>();
synchronized (this) {
for (Entry entry : spanners.entrySet()) {
@@ -416,7 +432,7 @@ void checkAndCloseSpanners(CheckAndCloseSpannersMode mode) {
// Force close all Spanner instances by passing in a value that will always be less than
// the
// difference between the current time and the close time of a connection.
- closeUnusedSpanners(Long.MIN_VALUE);
+ closeUnusedSpanners(Long.MIN_VALUE, closeSpannerFunction);
} else {
logLeakedConnections(keysStillInUse);
throw SpannerExceptionFactory.newSpannerException(
@@ -456,6 +472,11 @@ private void logLeakedConnections(List keysStillInUse) {
*/
@VisibleForTesting
void closeUnusedSpanners(long closeSpannerAfterMillisecondsUnused) {
+ closeUnusedSpanners(closeSpannerAfterMillisecondsUnused, DEFAULT_CLOSE_FUNCTION);
+ }
+
+ void closeUnusedSpanners(
+ long closeSpannerAfterMillisecondsUnused, Function closeSpannerFunction) {
List keysToBeRemoved = new ArrayList<>();
synchronized (this) {
for (Entry entry : lastConnectionClosedAt.entrySet()) {
@@ -469,7 +490,9 @@ void closeUnusedSpanners(long closeSpannerAfterMillisecondsUnused) {
Spanner spanner = spanners.get(entry.getKey());
if (spanner != null) {
try {
- spanner.close();
+ closeSpannerFunction.apply(spanner);
+ } catch (Throwable t) {
+ // Ignore any errors and continue with the next one in the pool.
} finally {
// Even if the close operation failed, we should remove the spanner object as it is no
// longer valid.
@@ -484,11 +507,4 @@ void closeUnusedSpanners(long closeSpannerAfterMillisecondsUnused) {
}
}
}
-
- @VisibleForTesting
- int getCurrentSpannerCount() {
- synchronized (this) {
- return spanners.size();
- }
- }
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/StatementExecutor.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/StatementExecutor.java
index baaadbe1676..131533a3374 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/StatementExecutor.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/StatementExecutor.java
@@ -164,6 +164,14 @@ private static ListeningExecutorService createExecutorService() {
this.interceptors = Collections.unmodifiableList(interceptors);
}
+ void shutdown() {
+ executor.shutdown();
+ }
+
+ void awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
+ executor.awaitTermination(timeout, unit);
+ }
+
/**
* Shutdown this executor now and do not wait for any statement that is being executed to finish.
*/
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ForceCloseSpannerFunction.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ForceCloseSpannerFunction.java
new file mode 100644
index 00000000000..a065a20bb52
--- /dev/null
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/ForceCloseSpannerFunction.java
@@ -0,0 +1,40 @@
+/*
+ * 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.spanner;
+
+import com.google.common.base.Function;
+import java.util.concurrent.TimeUnit;
+
+/** Class for tests that need to be able to force-close a {@link Spanner} instance. */
+public class ForceCloseSpannerFunction implements Function {
+ private final long timeout;
+ private final TimeUnit unit;
+
+ public ForceCloseSpannerFunction(long timeout, TimeUnit unit) {
+ this.timeout = timeout;
+ this.unit = unit;
+ }
+
+ public Void apply(Spanner spanner) {
+ if (spanner instanceof SpannerImpl) {
+ ((SpannerImpl) spanner).close(timeout, unit);
+ } else {
+ spanner.close();
+ }
+ return null;
+ }
+}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java
index b2ebd826615..112621f8533 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractMockServerTest.java
@@ -16,13 +16,16 @@
package com.google.cloud.spanner.connection;
+import com.google.cloud.spanner.ForceCloseSpannerFunction;
import com.google.cloud.spanner.MockSpannerServiceImpl;
import com.google.cloud.spanner.MockSpannerServiceImpl.StatementResult;
+import com.google.cloud.spanner.RandomResultSetGenerator;
import com.google.cloud.spanner.Statement;
import com.google.cloud.spanner.admin.database.v1.MockDatabaseAdminImpl;
import com.google.cloud.spanner.admin.instance.v1.MockInstanceAdminImpl;
import com.google.cloud.spanner.connection.ITAbstractSpannerTest.AbortInterceptor;
import com.google.cloud.spanner.connection.ITAbstractSpannerTest.ITConnection;
+import com.google.cloud.spanner.connection.SpannerPool.CheckAndCloseSpannersMode;
import com.google.common.util.concurrent.AbstractFuture;
import com.google.longrunning.GetOperationRequest;
import com.google.longrunning.Operation;
@@ -49,6 +52,7 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
+import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;
import org.junit.After;
import org.junit.AfterClass;
@@ -113,6 +117,7 @@ public abstract class AbstractMockServerTest {
private boolean futureParentHandlers;
private boolean exceptionRunnableParentHandlers;
private boolean nettyServerParentHandlers;
+ private boolean clientStreamParentHandlers;
@BeforeClass
public static void startStaticServer() throws IOException {
@@ -152,9 +157,7 @@ public void getOperation(
@AfterClass
public static void stopServer() throws Exception {
- SpannerPool.closeSpannerPool();
server.shutdown();
- server.awaitTermination();
}
@Before
@@ -169,22 +172,30 @@ public void setupResults() {
nettyServerParentHandlers =
Logger.getLogger("io.grpc.netty.shaded.io.grpc.netty.NettyServerHandler")
.getUseParentHandlers();
+ clientStreamParentHandlers =
+ Logger.getLogger("io.grpc.netty.shaded.io.grpc.netty.NettyServerHandler")
+ .getUseParentHandlers();
Logger.getLogger(AbstractFuture.class.getName()).setUseParentHandlers(false);
Logger.getLogger(LogExceptionRunnable.class.getName()).setUseParentHandlers(false);
Logger.getLogger("io.grpc.netty.shaded.io.grpc.netty.NettyServerHandler")
.setUseParentHandlers(false);
+ Logger.getLogger("io.grpc.internal.AbstractClientStream").setUseParentHandlers(false);
}
@After
public void closeSpannerPool() {
try {
- SpannerPool.closeSpannerPool();
+ SpannerPool.INSTANCE.checkAndCloseSpanners(
+ CheckAndCloseSpannersMode.ERROR,
+ new ForceCloseSpannerFunction(100L, TimeUnit.MILLISECONDS));
} finally {
Logger.getLogger(AbstractFuture.class.getName()).setUseParentHandlers(futureParentHandlers);
Logger.getLogger(LogExceptionRunnable.class.getName())
.setUseParentHandlers(exceptionRunnableParentHandlers);
Logger.getLogger("io.grpc.netty.shaded.io.grpc.netty.NettyServerHandler")
.setUseParentHandlers(nettyServerParentHandlers);
+ Logger.getLogger("io.grpc.internal.AbstractClientStream")
+ .setUseParentHandlers(clientStreamParentHandlers);
}
}
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java
index 9174ef81b22..4e1238077e2 100644
--- a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java
@@ -17,12 +17,15 @@
package com.google.cloud.spanner.connection;
import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
+import com.google.auth.Credentials;
import com.google.cloud.NoCredentials;
import com.google.cloud.spanner.ErrorCode;
import com.google.cloud.spanner.SessionPoolOptions;
@@ -430,8 +433,9 @@ public void testSpannerPoolKeyEquality() {
ConnectionOptions options1 =
ConnectionOptions.newBuilder()
.setUri(
- "cloudspanner:/projects/p/instances/i/databases/d?minSessions=200;maxSessions=400")
- .setCredentials(NoCredentials.getInstance())
+ "cloudspanner://localhost:9010/projects/p1/instances/i/databases/d"
+ + "?minSessions=200;maxSessions=400;numChannels=8;usePlainText=true;userAgent=test-agent")
+ .setCredentials(mock(Credentials.class))
.build();
// options2 equals the default session pool options, and is therefore equal to ConnectionOptions
// without any session pool configuration.
@@ -451,8 +455,9 @@ public void testSpannerPoolKeyEquality() {
SpannerPoolKey key2 = SpannerPoolKey.of(options2);
SpannerPoolKey key3 = SpannerPoolKey.of(options3);
- assertThat(key1).isNotEqualTo(key2);
- assertThat(key2).isEqualTo(key3);
- assertThat(key1).isNotEqualTo(key3);
+ assertFalse(key1.equals(key2));
+ assertTrue(key2.equals(key3));
+ assertFalse(key1.equals(key3));
+ assertFalse(key1.equals(new Object()));
}
}
From 7cdfb82b40487600547d0bad92119508161ca689 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Mon, 8 Feb 2021 17:22:10 -0800
Subject: [PATCH 30/42] feat: generate sample code in the Java microgenerator
(#859)
Committer: @miraleung
PiperOrigin-RevId: 356341083
Source-Author: Google APIs
Source-Date: Mon Feb 8 13:33:28 2021 -0800
Source-Repo: googleapis/googleapis
Source-Sha: 8d8c008e56f1af31d57f75561e0f1848ffb29eeb
Source-Link: https://github.com/googleapis/googleapis/commit/8d8c008e56f1af31d57f75561e0f1848ffb29eeb
---
.../database/v1/DatabaseAdminClient.java | 970 ++++++++++++++++++
.../admin/database/v1/package-info.java | 7 +
.../instance/v1/InstanceAdminClient.java | 541 ++++++++++
.../admin/instance/v1/package-info.java | 7 +
.../cloud/spanner/v1/SpannerClient.java | 675 ++++++++++++
.../google/cloud/spanner/v1/package-info.java | 7 +
synth.metadata | 6 +-
7 files changed, 2210 insertions(+), 3 deletions(-)
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java
index cab26e07702..9e829e30d4e 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java
@@ -85,6 +85,13 @@
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Database response = databaseAdminClient.getDatabase(name);
+ * }
+ * }
+ *
* Note: close() needs to be called on the DatabaseAdminClient object to clean up resources such
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
@@ -199,6 +206,17 @@ public final OperationsClient getOperationsClient() {
/**
* Lists Cloud Spanner databases.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance whose databases should be listed. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -215,6 +233,17 @@ public final ListDatabasesPagedResponse listDatabases(InstanceName parent) {
/**
* Lists Cloud Spanner databases.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance whose databases should be listed. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -228,6 +257,22 @@ public final ListDatabasesPagedResponse listDatabases(String parent) {
/**
* Lists Cloud Spanner databases.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListDatabasesRequest request =
+ * ListDatabasesRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (Database element : databaseAdminClient.listDatabases(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -240,6 +285,23 @@ public final ListDatabasesPagedResponse listDatabases(ListDatabasesRequest reque
* Lists Cloud Spanner databases.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListDatabasesRequest request =
+ * ListDatabasesRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.listDatabasesPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Database element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listDatabasesPagedCallable() {
@@ -251,6 +313,23 @@ public final ListDatabasesPagedResponse listDatabases(ListDatabasesRequest reque
* Lists Cloud Spanner databases.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * while (true) {
+ * ListDatabasesResponse response = databaseAdminClient.listDatabasesCallable().call(request);
+ * for (Database element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable listDatabasesCallable() {
return stub.listDatabasesCallable();
@@ -266,6 +345,16 @@ public final UnaryCallable listData
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * String createStatement = "createStatement744686547";
+ * Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance that will serve the new database. Values are
* of the form `projects/<project>/instances/<instance>`.
* @param createStatement Required. A `CREATE DATABASE` statement, which specifies the ID of the
@@ -295,6 +384,16 @@ public final OperationFuture createDatabaseAsy
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * String createStatement = "createStatement744686547";
+ * Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance that will serve the new database. Values are
* of the form `projects/<project>/instances/<instance>`.
* @param createStatement Required. A `CREATE DATABASE` statement, which specifies the ID of the
@@ -324,6 +423,20 @@ public final OperationFuture createDatabaseAsy
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * CreateDatabaseRequest request =
+ * CreateDatabaseRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setCreateStatement("createStatement744686547")
+ * .addAllExtraStatements(new ArrayList())
+ * .build();
+ * Database response = databaseAdminClient.createDatabaseAsync(request).get();
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -343,6 +456,21 @@ public final OperationFuture createDatabaseAsy
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * CreateDatabaseRequest request =
+ * CreateDatabaseRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setCreateStatement("createStatement744686547")
+ * .addAllExtraStatements(new ArrayList())
+ * .build();
+ * OperationFuture future =
+ * databaseAdminClient.createDatabaseOperationCallable().futureCall(request);
+ * // Do something.
+ * Database response = future.get();
+ * }
+ * }
*/
public final OperationCallable
createDatabaseOperationCallable() {
@@ -360,6 +488,21 @@ public final OperationFuture createDatabaseAsy
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * CreateDatabaseRequest request =
+ * CreateDatabaseRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setCreateStatement("createStatement744686547")
+ * .addAllExtraStatements(new ArrayList())
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.createDatabaseCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallable createDatabaseCallable() {
return stub.createDatabaseCallable();
@@ -369,6 +512,15 @@ public final UnaryCallable createDatabaseCalla
/**
* Gets the state of a Cloud Spanner database.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Database response = databaseAdminClient.getDatabase(name);
+ * }
+ * }
+ *
* @param name Required. The name of the requested database. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -383,6 +535,15 @@ public final Database getDatabase(DatabaseName name) {
/**
* Gets the state of a Cloud Spanner database.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * Database response = databaseAdminClient.getDatabase(name);
+ * }
+ * }
+ *
* @param name Required. The name of the requested database. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -396,6 +557,18 @@ public final Database getDatabase(String name) {
/**
* Gets the state of a Cloud Spanner database.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetDatabaseRequest request =
+ * GetDatabaseRequest.newBuilder()
+ * .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .build();
+ * Database response = databaseAdminClient.getDatabase(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -408,6 +581,18 @@ public final Database getDatabase(GetDatabaseRequest request) {
* Gets the state of a Cloud Spanner database.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetDatabaseRequest request =
+ * GetDatabaseRequest.newBuilder()
+ * .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .build();
+ * ApiFuture future = databaseAdminClient.getDatabaseCallable().futureCall(request);
+ * // Do something.
+ * Database response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getDatabaseCallable() {
return stub.getDatabaseCallable();
@@ -423,6 +608,16 @@ public final UnaryCallable getDatabaseCallable() {
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * List statements = new ArrayList<>();
+ * databaseAdminClient.updateDatabaseDdlAsync(database, statements).get();
+ * }
+ * }
+ *
* @param database Required. The database to update.
* @param statements Required. DDL statements to be applied to the database.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -447,6 +642,16 @@ public final OperationFuture updateDatabaseDdl
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * List statements = new ArrayList<>();
+ * databaseAdminClient.updateDatabaseDdlAsync(database, statements).get();
+ * }
+ * }
+ *
* @param database Required. The database to update.
* @param statements Required. DDL statements to be applied to the database.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -471,6 +676,20 @@ public final OperationFuture updateDatabaseDdl
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * UpdateDatabaseDdlRequest request =
+ * UpdateDatabaseDdlRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .addAllStatements(new ArrayList())
+ * .setOperationId("operationId129704162")
+ * .build();
+ * databaseAdminClient.updateDatabaseDdlAsync(request).get();
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -490,6 +709,21 @@ public final OperationFuture updateDatabaseDdl
* operation has no response.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * UpdateDatabaseDdlRequest request =
+ * UpdateDatabaseDdlRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .addAllStatements(new ArrayList())
+ * .setOperationId("operationId129704162")
+ * .build();
+ * OperationFuture future =
+ * databaseAdminClient.updateDatabaseDdlOperationCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final OperationCallable
updateDatabaseDdlOperationCallable() {
@@ -507,6 +741,21 @@ public final OperationFuture updateDatabaseDdl
* operation has no response.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * UpdateDatabaseDdlRequest request =
+ * UpdateDatabaseDdlRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .addAllStatements(new ArrayList())
+ * .setOperationId("operationId129704162")
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.updateDatabaseDdlCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallable updateDatabaseDdlCallable() {
return stub.updateDatabaseDdlCallable();
@@ -517,6 +766,15 @@ public final UnaryCallable updateDatabaseDd
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * databaseAdminClient.dropDatabase(database);
+ * }
+ * }
+ *
* @param database Required. The database to be dropped.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -533,6 +791,15 @@ public final void dropDatabase(DatabaseName database) {
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * databaseAdminClient.dropDatabase(database);
+ * }
+ * }
+ *
* @param database Required. The database to be dropped.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -546,6 +813,18 @@ public final void dropDatabase(String database) {
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DropDatabaseRequest request =
+ * DropDatabaseRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .build();
+ * databaseAdminClient.dropDatabase(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -559,6 +838,18 @@ public final void dropDatabase(DropDatabaseRequest request) {
* retained according to their `expire_time`.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DropDatabaseRequest request =
+ * DropDatabaseRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .build();
+ * ApiFuture future = databaseAdminClient.dropDatabaseCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallable dropDatabaseCallable() {
return stub.dropDatabaseCallable();
@@ -570,6 +861,15 @@ public final UnaryCallable dropDatabaseCallable() {
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database);
+ * }
+ * }
+ *
* @param database Required. The database whose schema we wish to get. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -588,6 +888,15 @@ public final GetDatabaseDdlResponse getDatabaseDdl(DatabaseName database) {
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database);
+ * }
+ * }
+ *
* @param database Required. The database whose schema we wish to get. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -604,6 +913,18 @@ public final GetDatabaseDdlResponse getDatabaseDdl(String database) {
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetDatabaseDdlRequest request =
+ * GetDatabaseDdlRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .build();
+ * GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -618,6 +939,19 @@ public final GetDatabaseDdlResponse getDatabaseDdl(GetDatabaseDdlRequest request
* [Operations][google.longrunning.Operations] API.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetDatabaseDdlRequest request =
+ * GetDatabaseDdlRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.getDatabaseDdlCallable().futureCall(request);
+ * // Do something.
+ * GetDatabaseDdlResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable
getDatabaseDdlCallable() {
@@ -633,6 +967,16 @@ public final GetDatabaseDdlResponse getDatabaseDdl(GetDatabaseDdlRequest request
* `spanner.backups.setIamPolicy` permission on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Policy policy = Policy.newBuilder().build();
+ * Policy response = databaseAdminClient.setIamPolicy(resource, policy);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
@@ -658,6 +1002,16 @@ public final Policy setIamPolicy(ResourceName resource, Policy policy) {
* `spanner.backups.setIamPolicy` permission on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * Policy policy = Policy.newBuilder().build();
+ * Policy response = databaseAdminClient.setIamPolicy(resource, policy);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
@@ -680,6 +1034,19 @@ public final Policy setIamPolicy(String resource, Policy policy) {
* `spanner.backups.setIamPolicy` permission on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * SetIamPolicyRequest request =
+ * SetIamPolicyRequest.newBuilder()
+ * .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setPolicy(Policy.newBuilder().build())
+ * .build();
+ * Policy response = databaseAdminClient.setIamPolicy(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -697,6 +1064,19 @@ public final Policy setIamPolicy(SetIamPolicyRequest request) {
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * SetIamPolicyRequest request =
+ * SetIamPolicyRequest.newBuilder()
+ * .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setPolicy(Policy.newBuilder().build())
+ * .build();
+ * ApiFuture future = databaseAdminClient.setIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
@@ -712,6 +1092,15 @@ public final UnaryCallable setIamPolicyCallable() {
* `spanner.backups.getIamPolicy` permission on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Policy response = databaseAdminClient.getIamPolicy(resource);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -734,6 +1123,15 @@ public final Policy getIamPolicy(ResourceName resource) {
* `spanner.backups.getIamPolicy` permission on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * Policy response = databaseAdminClient.getIamPolicy(resource);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -753,6 +1151,19 @@ public final Policy getIamPolicy(String resource) {
* `spanner.backups.getIamPolicy` permission on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * Policy response = databaseAdminClient.getIamPolicy(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -771,6 +1182,19 @@ public final Policy getIamPolicy(GetIamPolicyRequest request) {
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future = databaseAdminClient.getIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
@@ -786,6 +1210,17 @@ public final UnaryCallable getIamPolicyCallable() {
* does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list`
* permission on the containing instance.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * List permissions = new ArrayList<>();
+ * TestIamPermissionsResponse response =
+ * databaseAdminClient.testIamPermissions(resource, permissions);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
@@ -813,6 +1248,17 @@ public final TestIamPermissionsResponse testIamPermissions(
* does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list`
* permission on the containing instance.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * List permissions = new ArrayList<>();
+ * TestIamPermissionsResponse response =
+ * databaseAdminClient.testIamPermissions(resource, permissions);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
@@ -840,6 +1286,19 @@ public final TestIamPermissionsResponse testIamPermissions(
* does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list`
* permission on the containing instance.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * TestIamPermissionsRequest request =
+ * TestIamPermissionsRequest.newBuilder()
+ * .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .addAllPermissions(new ArrayList())
+ * .build();
+ * TestIamPermissionsResponse response = databaseAdminClient.testIamPermissions(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -858,6 +1317,20 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq
* permission on the containing instance.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * TestIamPermissionsRequest request =
+ * TestIamPermissionsRequest.newBuilder()
+ * .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .addAllPermissions(new ArrayList())
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.testIamPermissionsCallable().futureCall(request);
+ * // Do something.
+ * TestIamPermissionsResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable
testIamPermissionsCallable() {
@@ -877,6 +1350,17 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq
* operation will stop the creation and delete the backup. There can be only one pending backup
* creation per database. Backup creation of different databases can run concurrently.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * Backup backup = Backup.newBuilder().build();
+ * String backupId = "backupId2121930365";
+ * Backup response = databaseAdminClient.createBackupAsync(parent, backup, backupId).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance in which the backup will be created. This must
* be the same instance that contains the database the backup will be created from. The backup
* will be stored in the location(s) specified in the instance configuration of this instance.
@@ -911,6 +1395,17 @@ public final OperationFuture createBackupAsync(
* operation will stop the creation and delete the backup. There can be only one pending backup
* creation per database. Backup creation of different databases can run concurrently.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * Backup backup = Backup.newBuilder().build();
+ * String backupId = "backupId2121930365";
+ * Backup response = databaseAdminClient.createBackupAsync(parent, backup, backupId).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance in which the backup will be created. This must
* be the same instance that contains the database the backup will be created from. The backup
* will be stored in the location(s) specified in the instance configuration of this instance.
@@ -945,6 +1440,20 @@ public final OperationFuture createBackupAsync(
* operation will stop the creation and delete the backup. There can be only one pending backup
* creation per database. Backup creation of different databases can run concurrently.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * CreateBackupRequest request =
+ * CreateBackupRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setBackupId("backupId2121930365")
+ * .setBackup(Backup.newBuilder().build())
+ * .build();
+ * Backup response = databaseAdminClient.createBackupAsync(request).get();
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -967,6 +1476,21 @@ public final OperationFuture createBackupAsync(
* creation per database. Backup creation of different databases can run concurrently.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * CreateBackupRequest request =
+ * CreateBackupRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setBackupId("backupId2121930365")
+ * .setBackup(Backup.newBuilder().build())
+ * .build();
+ * OperationFuture future =
+ * databaseAdminClient.createBackupOperationCallable().futureCall(request);
+ * // Do something.
+ * Backup response = future.get();
+ * }
+ * }
*/
public final OperationCallable
createBackupOperationCallable() {
@@ -987,6 +1511,20 @@ public final OperationFuture createBackupAsync(
* creation per database. Backup creation of different databases can run concurrently.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * CreateBackupRequest request =
+ * CreateBackupRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setBackupId("backupId2121930365")
+ * .setBackup(Backup.newBuilder().build())
+ * .build();
+ * ApiFuture future = databaseAdminClient.createBackupCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallable createBackupCallable() {
return stub.createBackupCallable();
@@ -996,6 +1534,15 @@ public final UnaryCallable createBackupCallable(
/**
* Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+ * Backup response = databaseAdminClient.getBackup(name);
+ * }
+ * }
+ *
* @param name Required. Name of the backup. Values are of the form
* `projects/<project>/instances/<instance>/backups/<backup>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1010,6 +1557,15 @@ public final Backup getBackup(BackupName name) {
/**
* Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+ * Backup response = databaseAdminClient.getBackup(name);
+ * }
+ * }
+ *
* @param name Required. Name of the backup. Values are of the form
* `projects/<project>/instances/<instance>/backups/<backup>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1023,6 +1579,18 @@ public final Backup getBackup(String name) {
/**
* Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetBackupRequest request =
+ * GetBackupRequest.newBuilder()
+ * .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+ * .build();
+ * Backup response = databaseAdminClient.getBackup(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1035,6 +1603,18 @@ public final Backup getBackup(GetBackupRequest request) {
* Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * GetBackupRequest request =
+ * GetBackupRequest.newBuilder()
+ * .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+ * .build();
+ * ApiFuture future = databaseAdminClient.getBackupCallable().futureCall(request);
+ * // Do something.
+ * Backup response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getBackupCallable() {
return stub.getBackupCallable();
@@ -1044,6 +1624,16 @@ public final UnaryCallable getBackupCallable() {
/**
* Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * Backup backup = Backup.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * Backup response = databaseAdminClient.updateBackup(backup, updateMask);
+ * }
+ * }
+ *
* @param backup Required. The backup to update. `backup.name`, and the fields to be updated as
* specified by `update_mask` are required. Other fields are ignored. Update is only supported
* for the following fields: * `backup.expire_time`.
@@ -1063,6 +1653,19 @@ public final Backup updateBackup(Backup backup, FieldMask updateMask) {
/**
* Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * UpdateBackupRequest request =
+ * UpdateBackupRequest.newBuilder()
+ * .setBackup(Backup.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * Backup response = databaseAdminClient.updateBackup(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1075,6 +1678,19 @@ public final Backup updateBackup(UpdateBackupRequest request) {
* Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * UpdateBackupRequest request =
+ * UpdateBackupRequest.newBuilder()
+ * .setBackup(Backup.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future = databaseAdminClient.updateBackupCallable().futureCall(request);
+ * // Do something.
+ * Backup response = future.get();
+ * }
+ * }
*/
public final UnaryCallable updateBackupCallable() {
return stub.updateBackupCallable();
@@ -1084,6 +1700,15 @@ public final UnaryCallable updateBackupCallable() {
/**
* Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+ * databaseAdminClient.deleteBackup(name);
+ * }
+ * }
+ *
* @param name Required. Name of the backup to delete. Values are of the form
* `projects/<project>/instances/<instance>/backups/<backup>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1098,6 +1723,15 @@ public final void deleteBackup(BackupName name) {
/**
* Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+ * databaseAdminClient.deleteBackup(name);
+ * }
+ * }
+ *
* @param name Required. Name of the backup to delete. Values are of the form
* `projects/<project>/instances/<instance>/backups/<backup>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1111,6 +1745,18 @@ public final void deleteBackup(String name) {
/**
* Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DeleteBackupRequest request =
+ * DeleteBackupRequest.newBuilder()
+ * .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+ * .build();
+ * databaseAdminClient.deleteBackup(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1123,6 +1769,18 @@ public final void deleteBackup(DeleteBackupRequest request) {
* Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DeleteBackupRequest request =
+ * DeleteBackupRequest.newBuilder()
+ * .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+ * .build();
+ * ApiFuture future = databaseAdminClient.deleteBackupCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallable deleteBackupCallable() {
return stub.deleteBackupCallable();
@@ -1133,6 +1791,17 @@ public final UnaryCallable deleteBackupCallable() {
* Lists completed and pending backups. Backups returned are ordered by `create_time` in
* descending order, starting from the most recent `create_time`.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * for (Backup element : databaseAdminClient.listBackups(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance to list backups from. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1150,6 +1819,17 @@ public final ListBackupsPagedResponse listBackups(InstanceName parent) {
* Lists completed and pending backups. Backups returned are ordered by `create_time` in
* descending order, starting from the most recent `create_time`.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * for (Backup element : databaseAdminClient.listBackups(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance to list backups from. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1164,6 +1844,23 @@ public final ListBackupsPagedResponse listBackups(String parent) {
* Lists completed and pending backups. Backups returned are ordered by `create_time` in
* descending order, starting from the most recent `create_time`.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListBackupsRequest request =
+ * ListBackupsRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (Backup element : databaseAdminClient.listBackups(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1177,6 +1874,23 @@ public final ListBackupsPagedResponse listBackups(ListBackupsRequest request) {
* descending order, starting from the most recent `create_time`.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListBackupsRequest request =
+ * ListBackupsRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future = databaseAdminClient.listBackupsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Backup element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listBackupsPagedCallable() {
@@ -1189,6 +1903,23 @@ public final ListBackupsPagedResponse listBackups(ListBackupsRequest request) {
* descending order, starting from the most recent `create_time`.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * while (true) {
+ * ListBackupsResponse response = databaseAdminClient.listBackupsCallable().call(request);
+ * for (Backup element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable listBackupsCallable() {
return stub.listBackupsCallable();
@@ -1211,6 +1942,18 @@ public final UnaryCallable listBackupsC
* operation can be initiated, without waiting for the optimize operation associated with the
* first restore to complete.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * String databaseId = "databaseId1688905718";
+ * BackupName backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+ * Database response =
+ * databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance in which to create the restored database. This
* instance must be in the same project and have the same instance configuration as the
* instance containing the source backup. Values are of the form
@@ -1251,6 +1994,18 @@ public final OperationFuture restoreDatabaseA
* operation can be initiated, without waiting for the optimize operation associated with the
* first restore to complete.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * String databaseId = "databaseId1688905718";
+ * String backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+ * Database response =
+ * databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance in which to create the restored database. This
* instance must be in the same project and have the same instance configuration as the
* instance containing the source backup. Values are of the form
@@ -1291,6 +2046,18 @@ public final OperationFuture restoreDatabaseA
* operation can be initiated, without waiting for the optimize operation associated with the
* first restore to complete.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * String databaseId = "databaseId1688905718";
+ * BackupName backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+ * Database response =
+ * databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance in which to create the restored database. This
* instance must be in the same project and have the same instance configuration as the
* instance containing the source backup. Values are of the form
@@ -1331,6 +2098,18 @@ public final OperationFuture restoreDatabaseA
* operation can be initiated, without waiting for the optimize operation associated with the
* first restore to complete.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * String databaseId = "databaseId1688905718";
+ * String backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+ * Database response =
+ * databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the instance in which to create the restored database. This
* instance must be in the same project and have the same instance configuration as the
* instance containing the source backup. Values are of the form
@@ -1371,6 +2150,19 @@ public final OperationFuture restoreDatabaseA
* operation can be initiated, without waiting for the optimize operation associated with the
* first restore to complete.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * RestoreDatabaseRequest request =
+ * RestoreDatabaseRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setDatabaseId("databaseId1688905718")
+ * .build();
+ * Database response = databaseAdminClient.restoreDatabaseAsync(request).get();
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1397,6 +2189,20 @@ public final OperationFuture restoreDatabaseA
* first restore to complete.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * RestoreDatabaseRequest request =
+ * RestoreDatabaseRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setDatabaseId("databaseId1688905718")
+ * .build();
+ * OperationFuture future =
+ * databaseAdminClient.restoreDatabaseOperationCallable().futureCall(request);
+ * // Do something.
+ * Database response = future.get();
+ * }
+ * }
*/
public final OperationCallable
restoreDatabaseOperationCallable() {
@@ -1421,6 +2227,20 @@ public final OperationFuture restoreDatabaseA
* first restore to complete.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * RestoreDatabaseRequest request =
+ * RestoreDatabaseRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setDatabaseId("databaseId1688905718")
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.restoreDatabaseCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallable restoreDatabaseCallable() {
return stub.restoreDatabaseCallable();
@@ -1435,6 +2255,17 @@ public final UnaryCallable restoreDatabaseCal
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * for (Operation element : databaseAdminClient.listDatabaseOperations(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance of the database operations. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1456,6 +2287,17 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(Instance
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * for (Operation element : databaseAdminClient.listDatabaseOperations(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance of the database operations. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1475,6 +2317,23 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(String p
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListDatabaseOperationsRequest request =
+ * ListDatabaseOperationsRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (Operation element : databaseAdminClient.listDatabaseOperations(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1493,6 +2352,24 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(
* have completed/failed/canceled within the last 7 days, and pending operations.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListDatabaseOperationsRequest request =
+ * ListDatabaseOperationsRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.listDatabaseOperationsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Operation element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listDatabaseOperationsPagedCallable() {
@@ -1509,6 +2386,24 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(
* have completed/failed/canceled within the last 7 days, and pending operations.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * while (true) {
+ * ListDatabaseOperationsResponse response =
+ * databaseAdminClient.listDatabaseOperationsCallable().call(request);
+ * for (Operation element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listDatabaseOperationsCallable() {
@@ -1526,6 +2421,17 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(
* returned are ordered by `operation.metadata.value.progress.start_time` in descending order
* starting from the most recently started operation.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * for (Operation element : databaseAdminClient.listBackupOperations(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance of the backup operations. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1549,6 +2455,17 @@ public final ListBackupOperationsPagedResponse listBackupOperations(InstanceName
* returned are ordered by `operation.metadata.value.progress.start_time` in descending order
* starting from the most recently started operation.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * for (Operation element : databaseAdminClient.listBackupOperations(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The instance of the backup operations. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1570,6 +2487,23 @@ public final ListBackupOperationsPagedResponse listBackupOperations(String paren
* returned are ordered by `operation.metadata.value.progress.start_time` in descending order
* starting from the most recently started operation.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListBackupOperationsRequest request =
+ * ListBackupOperationsRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (Operation element : databaseAdminClient.listBackupOperations(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1590,6 +2524,24 @@ public final ListBackupOperationsPagedResponse listBackupOperations(
* starting from the most recently started operation.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * ListBackupOperationsRequest request =
+ * ListBackupOperationsRequest.newBuilder()
+ * .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * databaseAdminClient.listBackupOperationsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Operation element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listBackupOperationsPagedCallable() {
@@ -1608,6 +2560,24 @@ public final ListBackupOperationsPagedResponse listBackupOperations(
* starting from the most recently started operation.
*
* Sample code:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * while (true) {
+ * ListBackupOperationsResponse response =
+ * databaseAdminClient.listBackupOperationsCallable().call(request);
+ * for (Operation element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listBackupOperationsCallable() {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java
index a7a4a8722e0..6723f47e828 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java
@@ -26,6 +26,13 @@
* list backups for a database and to restore from an existing backup.
*
* Sample for DatabaseAdminClient:
+ *
+ *
{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ * DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Database response = databaseAdminClient.getDatabase(name);
+ * }
+ * }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.spanner.admin.database.v1;
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java
index 6494e0eac90..68c0be81db8 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java
@@ -85,6 +85,13 @@
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
+ * InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+ * }
+ * }
+ *
* Note: close() needs to be called on the InstanceAdminClient object to clean up resources such
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
@@ -199,6 +206,17 @@ public final OperationsClient getOperationsClient() {
/**
* Lists the supported instance configurations for a given project.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ProjectName parent = ProjectName.of("[PROJECT]");
+ * for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The name of the project for which a list of supported instance
* configurations is requested. Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -215,6 +233,17 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(ProjectName pa
/**
* Lists the supported instance configurations for a given project.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String parent = ProjectName.of("[PROJECT]").toString();
+ * for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The name of the project for which a list of supported instance
* configurations is requested. Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -229,6 +258,22 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(String parent)
/**
* Lists the supported instance configurations for a given project.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ListInstanceConfigsRequest request =
+ * ListInstanceConfigsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -242,6 +287,23 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(
* Lists the supported instance configurations for a given project.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ListInstanceConfigsRequest request =
+ * ListInstanceConfigsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * instanceAdminClient.listInstanceConfigsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (InstanceConfig element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listInstanceConfigsPagedCallable() {
@@ -253,6 +315,24 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(
* Lists the supported instance configurations for a given project.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * while (true) {
+ * ListInstanceConfigsResponse response =
+ * instanceAdminClient.listInstanceConfigsCallable().call(request);
+ * for (InstanceConfig element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listInstanceConfigsCallable() {
@@ -263,6 +343,15 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(
/**
* Gets information about a particular instance configuration.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
+ * InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+ * }
+ * }
+ *
* @param name Required. The name of the requested instance configuration. Values are of the form
* `projects/<project>/instanceConfigs/<config>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -279,6 +368,15 @@ public final InstanceConfig getInstanceConfig(InstanceConfigName name) {
/**
* Gets information about a particular instance configuration.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString();
+ * InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+ * }
+ * }
+ *
* @param name Required. The name of the requested instance configuration. Values are of the form
* `projects/<project>/instanceConfigs/<config>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -292,6 +390,18 @@ public final InstanceConfig getInstanceConfig(String name) {
/**
* Gets information about a particular instance configuration.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * GetInstanceConfigRequest request =
+ * GetInstanceConfigRequest.newBuilder()
+ * .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
+ * .build();
+ * InstanceConfig response = instanceAdminClient.getInstanceConfig(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -304,6 +414,19 @@ public final InstanceConfig getInstanceConfig(GetInstanceConfigRequest request)
* Gets information about a particular instance configuration.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * GetInstanceConfigRequest request =
+ * GetInstanceConfigRequest.newBuilder()
+ * .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
+ * .build();
+ * ApiFuture future =
+ * instanceAdminClient.getInstanceConfigCallable().futureCall(request);
+ * // Do something.
+ * InstanceConfig response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getInstanceConfigCallable() {
return stub.getInstanceConfigCallable();
@@ -313,6 +436,17 @@ public final UnaryCallable getInstance
/**
* Lists all instances in the given project.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ProjectName parent = ProjectName.of("[PROJECT]");
+ * for (Instance element : instanceAdminClient.listInstances(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The name of the project for which a list of instances is requested.
* Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -329,6 +463,17 @@ public final ListInstancesPagedResponse listInstances(ProjectName parent) {
/**
* Lists all instances in the given project.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String parent = ProjectName.of("[PROJECT]").toString();
+ * for (Instance element : instanceAdminClient.listInstances(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The name of the project for which a list of instances is requested.
* Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -342,6 +487,23 @@ public final ListInstancesPagedResponse listInstances(String parent) {
/**
* Lists all instances in the given project.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ListInstancesRequest request =
+ * ListInstancesRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * for (Instance element : instanceAdminClient.listInstances(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -354,6 +516,24 @@ public final ListInstancesPagedResponse listInstances(ListInstancesRequest reque
* Lists all instances in the given project.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ListInstancesRequest request =
+ * ListInstancesRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ApiFuture future =
+ * instanceAdminClient.listInstancesPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Instance element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listInstancesPagedCallable() {
@@ -365,6 +545,23 @@ public final ListInstancesPagedResponse listInstances(ListInstancesRequest reque
* Lists all instances in the given project.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * while (true) {
+ * ListInstancesResponse response = instanceAdminClient.listInstancesCallable().call(request);
+ * for (Instance element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable listInstancesCallable() {
return stub.listInstancesCallable();
@@ -374,6 +571,15 @@ public final UnaryCallable listInst
/**
* Gets information about a particular instance.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * Instance response = instanceAdminClient.getInstance(name);
+ * }
+ * }
+ *
* @param name Required. The name of the requested instance. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -388,6 +594,15 @@ public final Instance getInstance(InstanceName name) {
/**
* Gets information about a particular instance.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * Instance response = instanceAdminClient.getInstance(name);
+ * }
+ * }
+ *
* @param name Required. The name of the requested instance. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -401,6 +616,19 @@ public final Instance getInstance(String name) {
/**
* Gets information about a particular instance.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * GetInstanceRequest request =
+ * GetInstanceRequest.newBuilder()
+ * .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFieldMask(FieldMask.newBuilder().build())
+ * .build();
+ * Instance response = instanceAdminClient.getInstance(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -413,6 +641,19 @@ public final Instance getInstance(GetInstanceRequest request) {
* Gets information about a particular instance.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * GetInstanceRequest request =
+ * GetInstanceRequest.newBuilder()
+ * .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .setFieldMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future = instanceAdminClient.getInstanceCallable().futureCall(request);
+ * // Do something.
+ * Instance response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getInstanceCallable() {
return stub.getInstanceCallable();
@@ -450,6 +691,18 @@ public final UnaryCallable getInstanceCallable() {
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ProjectName parent = ProjectName.of("[PROJECT]");
+ * String instanceId = "instanceId902024336";
+ * Instance instance = Instance.newBuilder().build();
+ * Instance response =
+ * instanceAdminClient.createInstanceAsync(parent, instanceId, instance).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the project in which to create the instance. Values are of
* the form `projects/<project>`.
* @param instanceId Required. The ID of the instance to create. Valid identifiers are of the form
@@ -501,6 +754,18 @@ public final OperationFuture createInstanceAsy
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String parent = ProjectName.of("[PROJECT]").toString();
+ * String instanceId = "instanceId902024336";
+ * Instance instance = Instance.newBuilder().build();
+ * Instance response =
+ * instanceAdminClient.createInstanceAsync(parent, instanceId, instance).get();
+ * }
+ * }
+ *
* @param parent Required. The name of the project in which to create the instance. Values are of
* the form `projects/<project>`.
* @param instanceId Required. The ID of the instance to create. Valid identifiers are of the form
@@ -552,6 +817,20 @@ public final OperationFuture createInstanceAsy
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * CreateInstanceRequest request =
+ * CreateInstanceRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setInstanceId("instanceId902024336")
+ * .setInstance(Instance.newBuilder().build())
+ * .build();
+ * Instance response = instanceAdminClient.createInstanceAsync(request).get();
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -593,6 +872,21 @@ public final OperationFuture createInstanceAsy
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * CreateInstanceRequest request =
+ * CreateInstanceRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setInstanceId("instanceId902024336")
+ * .setInstance(Instance.newBuilder().build())
+ * .build();
+ * OperationFuture future =
+ * instanceAdminClient.createInstanceOperationCallable().futureCall(request);
+ * // Do something.
+ * Instance response = future.get();
+ * }
+ * }
*/
public final OperationCallable
createInstanceOperationCallable() {
@@ -632,6 +926,21 @@ public final OperationFuture createInstanceAsy
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * CreateInstanceRequest request =
+ * CreateInstanceRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setInstanceId("instanceId902024336")
+ * .setInstance(Instance.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * instanceAdminClient.createInstanceCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallable createInstanceCallable() {
return stub.createInstanceCallable();
@@ -673,6 +982,16 @@ public final UnaryCallable createInstanceCalla
* Authorization requires `spanner.instances.update` permission on resource
* [name][google.spanner.admin.instance.v1.Instance.name].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * Instance instance = Instance.newBuilder().build();
+ * FieldMask fieldMask = FieldMask.newBuilder().build();
+ * Instance response = instanceAdminClient.updateInstanceAsync(instance, fieldMask).get();
+ * }
+ * }
+ *
* @param instance Required. The instance to update, which must always include the instance name.
* Otherwise, only fields mentioned in
* [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be
@@ -727,6 +1046,19 @@ public final OperationFuture updateInstanceAsy
* Authorization requires `spanner.instances.update` permission on resource
* [name][google.spanner.admin.instance.v1.Instance.name].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * UpdateInstanceRequest request =
+ * UpdateInstanceRequest.newBuilder()
+ * .setInstance(Instance.newBuilder().build())
+ * .setFieldMask(FieldMask.newBuilder().build())
+ * .build();
+ * Instance response = instanceAdminClient.updateInstanceAsync(request).get();
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -772,6 +1104,20 @@ public final OperationFuture updateInstanceAsy
* [name][google.spanner.admin.instance.v1.Instance.name].
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * UpdateInstanceRequest request =
+ * UpdateInstanceRequest.newBuilder()
+ * .setInstance(Instance.newBuilder().build())
+ * .setFieldMask(FieldMask.newBuilder().build())
+ * .build();
+ * OperationFuture future =
+ * instanceAdminClient.updateInstanceOperationCallable().futureCall(request);
+ * // Do something.
+ * Instance response = future.get();
+ * }
+ * }
*/
public final OperationCallable
updateInstanceOperationCallable() {
@@ -815,6 +1161,20 @@ public final OperationFuture updateInstanceAsy
* [name][google.spanner.admin.instance.v1.Instance.name].
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * UpdateInstanceRequest request =
+ * UpdateInstanceRequest.newBuilder()
+ * .setInstance(Instance.newBuilder().build())
+ * .setFieldMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * instanceAdminClient.updateInstanceCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallable updateInstanceCallable() {
return stub.updateInstanceCallable();
@@ -833,6 +1193,15 @@ public final UnaryCallable updateInstanceCalla
* * The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
+ * instanceAdminClient.deleteInstance(name);
+ * }
+ * }
+ *
* @param name Required. The name of the instance to be deleted. Values are of the form
* `projects/<project>/instances/<instance>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -856,6 +1225,15 @@ public final void deleteInstance(InstanceName name) {
* * The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+ * instanceAdminClient.deleteInstance(name);
+ * }
+ * }
+ *
* @param name Required. The name of the instance to be deleted. Values are of the form
* `projects/<project>/instances/<instance>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -878,6 +1256,18 @@ public final void deleteInstance(String name) {
* * The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * DeleteInstanceRequest request =
+ * DeleteInstanceRequest.newBuilder()
+ * .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .build();
+ * instanceAdminClient.deleteInstance(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -899,6 +1289,18 @@ public final void deleteInstance(DeleteInstanceRequest request) {
* from the API. All data in the databases is permanently deleted.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * DeleteInstanceRequest request =
+ * DeleteInstanceRequest.newBuilder()
+ * .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+ * .build();
+ * ApiFuture future = instanceAdminClient.deleteInstanceCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallable deleteInstanceCallable() {
return stub.deleteInstanceCallable();
@@ -911,6 +1313,16 @@ public final UnaryCallable deleteInstanceCallable(
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ResourceName resource = ProjectName.of("[PROJECT]");
+ * Policy policy = Policy.newBuilder().build();
+ * Policy response = instanceAdminClient.setIamPolicy(resource, policy);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
@@ -934,6 +1346,16 @@ public final Policy setIamPolicy(ResourceName resource, Policy policy) {
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String resource = ProjectName.of("[PROJECT]").toString();
+ * Policy policy = Policy.newBuilder().build();
+ * Policy response = instanceAdminClient.setIamPolicy(resource, policy);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
@@ -954,6 +1376,19 @@ public final Policy setIamPolicy(String resource, Policy policy) {
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * SetIamPolicyRequest request =
+ * SetIamPolicyRequest.newBuilder()
+ * .setResource(ProjectName.of("[PROJECT]").toString())
+ * .setPolicy(Policy.newBuilder().build())
+ * .build();
+ * Policy response = instanceAdminClient.setIamPolicy(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -969,6 +1404,19 @@ public final Policy setIamPolicy(SetIamPolicyRequest request) {
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * SetIamPolicyRequest request =
+ * SetIamPolicyRequest.newBuilder()
+ * .setResource(ProjectName.of("[PROJECT]").toString())
+ * .setPolicy(Policy.newBuilder().build())
+ * .build();
+ * ApiFuture future = instanceAdminClient.setIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
@@ -982,6 +1430,15 @@ public final UnaryCallable setIamPolicyCallable() {
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ResourceName resource = ProjectName.of("[PROJECT]");
+ * Policy response = instanceAdminClient.getIamPolicy(resource);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1002,6 +1459,15 @@ public final Policy getIamPolicy(ResourceName resource) {
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String resource = ProjectName.of("[PROJECT]").toString();
+ * Policy response = instanceAdminClient.getIamPolicy(resource);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1019,6 +1485,19 @@ public final Policy getIamPolicy(String resource) {
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(ProjectName.of("[PROJECT]").toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * Policy response = instanceAdminClient.getIamPolicy(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1035,6 +1514,19 @@ public final Policy getIamPolicy(GetIamPolicyRequest request) {
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(ProjectName.of("[PROJECT]").toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future = instanceAdminClient.getIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
@@ -1048,6 +1540,17 @@ public final UnaryCallable getIamPolicyCallable() {
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * ResourceName resource = ProjectName.of("[PROJECT]");
+ * List permissions = new ArrayList<>();
+ * TestIamPermissionsResponse response =
+ * instanceAdminClient.testIamPermissions(resource, permissions);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
@@ -1073,6 +1576,17 @@ public final TestIamPermissionsResponse testIamPermissions(
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * String resource = ProjectName.of("[PROJECT]").toString();
+ * List permissions = new ArrayList<>();
+ * TestIamPermissionsResponse response =
+ * instanceAdminClient.testIamPermissions(resource, permissions);
+ * }
+ * }
+ *
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
@@ -1098,6 +1612,19 @@ public final TestIamPermissionsResponse testIamPermissions(
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * TestIamPermissionsRequest request =
+ * TestIamPermissionsRequest.newBuilder()
+ * .setResource(ProjectName.of("[PROJECT]").toString())
+ * .addAllPermissions(new ArrayList())
+ * .build();
+ * TestIamPermissionsResponse response = instanceAdminClient.testIamPermissions(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1114,6 +1641,20 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq
* Cloud Project. Otherwise returns an empty set of permissions.
*
* Sample code:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * TestIamPermissionsRequest request =
+ * TestIamPermissionsRequest.newBuilder()
+ * .setResource(ProjectName.of("[PROJECT]").toString())
+ * .addAllPermissions(new ArrayList())
+ * .build();
+ * ApiFuture future =
+ * instanceAdminClient.testIamPermissionsCallable().futureCall(request);
+ * // Do something.
+ * TestIamPermissionsResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable
testIamPermissionsCallable() {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java
index 189e53a2d60..19b1d13aca7 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java
@@ -38,6 +38,13 @@
* databases in that instance, and their performance may suffer.
*
* Sample for InstanceAdminClient:
+ *
+ *
{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ * InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
+ * InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+ * }
+ * }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.spanner.admin.instance.v1;
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java
index 2c430faaade..c05c3d5ee9e 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java
@@ -73,6 +73,13 @@
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Session response = spannerClient.createSession(database);
+ * }
+ * }
+ *
* Note: close() needs to be called on the SpannerClient object to clean up resources such as
* threads. In the example above, try-with-resources is used, which automatically calls close().
*
@@ -187,6 +194,15 @@ public SpannerStub getStub() {
*
Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT
* 1"`.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Session response = spannerClient.createSession(database);
+ * }
+ * }
+ *
* @param database Required. The database in which the new session is created.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -216,6 +232,15 @@ public final Session createSession(DatabaseName database) {
* Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT
* 1"`.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * Session response = spannerClient.createSession(database);
+ * }
+ * }
+ *
* @param database Required. The database in which the new session is created.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -242,6 +267,19 @@ public final Session createSession(String database) {
* Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT
* 1"`.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * CreateSessionRequest request =
+ * CreateSessionRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setSession(Session.newBuilder().build())
+ * .build();
+ * Session response = spannerClient.createSession(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -268,6 +306,19 @@ public final Session createSession(CreateSessionRequest request) {
* 1"`.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * CreateSessionRequest request =
+ * CreateSessionRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setSession(Session.newBuilder().build())
+ * .build();
+ * ApiFuture future = spannerClient.createSessionCallable().futureCall(request);
+ * // Do something.
+ * Session response = future.get();
+ * }
+ * }
*/
public final UnaryCallable createSessionCallable() {
return stub.createSessionCallable();
@@ -280,6 +331,17 @@ public final UnaryCallable createSessionCallable(
* This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2
* for best practices on session cache management.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * int sessionCount = 185691686;
+ * BatchCreateSessionsResponse response =
+ * spannerClient.batchCreateSessions(database, sessionCount);
+ * }
+ * }
+ *
* @param database Required. The database in which the new sessions are created.
* @param sessionCount Required. The number of sessions to be created in this batch call. The API
* may return fewer than the requested number of sessions. If a specific number of sessions
@@ -304,6 +366,17 @@ public final BatchCreateSessionsResponse batchCreateSessions(
* This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2
* for best practices on session cache management.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * int sessionCount = 185691686;
+ * BatchCreateSessionsResponse response =
+ * spannerClient.batchCreateSessions(database, sessionCount);
+ * }
+ * }
+ *
* @param database Required. The database in which the new sessions are created.
* @param sessionCount Required. The number of sessions to be created in this batch call. The API
* may return fewer than the requested number of sessions. If a specific number of sessions
@@ -327,6 +400,20 @@ public final BatchCreateSessionsResponse batchCreateSessions(String database, in
* This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2
* for best practices on session cache management.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * BatchCreateSessionsRequest request =
+ * BatchCreateSessionsRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setSessionTemplate(Session.newBuilder().build())
+ * .setSessionCount(185691686)
+ * .build();
+ * BatchCreateSessionsResponse response = spannerClient.batchCreateSessions(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -342,6 +429,21 @@ public final BatchCreateSessionsResponse batchCreateSessions(BatchCreateSessions
* for best practices on session cache management.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * BatchCreateSessionsRequest request =
+ * BatchCreateSessionsRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setSessionTemplate(Session.newBuilder().build())
+ * .setSessionCount(185691686)
+ * .build();
+ * ApiFuture future =
+ * spannerClient.batchCreateSessionsCallable().futureCall(request);
+ * // Do something.
+ * BatchCreateSessionsResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable
batchCreateSessionsCallable() {
@@ -353,6 +455,15 @@ public final BatchCreateSessionsResponse batchCreateSessions(BatchCreateSessions
* Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for
* determining whether a session is still alive.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+ * Session response = spannerClient.getSession(name);
+ * }
+ * }
+ *
* @param name Required. The name of the session to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -367,6 +478,15 @@ public final Session getSession(SessionName name) {
* Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for
* determining whether a session is still alive.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+ * Session response = spannerClient.getSession(name);
+ * }
+ * }
+ *
* @param name Required. The name of the session to retrieve.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -380,6 +500,19 @@ public final Session getSession(String name) {
* Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for
* determining whether a session is still alive.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * GetSessionRequest request =
+ * GetSessionRequest.newBuilder()
+ * .setName(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .build();
+ * Session response = spannerClient.getSession(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -393,6 +526,19 @@ public final Session getSession(GetSessionRequest request) {
* determining whether a session is still alive.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * GetSessionRequest request =
+ * GetSessionRequest.newBuilder()
+ * .setName(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .build();
+ * ApiFuture future = spannerClient.getSessionCallable().futureCall(request);
+ * // Do something.
+ * Session response = future.get();
+ * }
+ * }
*/
public final UnaryCallable getSessionCallable() {
return stub.getSessionCallable();
@@ -402,6 +548,17 @@ public final UnaryCallable getSessionCallable() {
/**
* Lists all sessions in a given database.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * for (Session element : spannerClient.listSessions(database).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param database Required. The database in which to list sessions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -417,6 +574,17 @@ public final ListSessionsPagedResponse listSessions(DatabaseName database) {
/**
* Lists all sessions in a given database.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+ * for (Session element : spannerClient.listSessions(database).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param database Required. The database in which to list sessions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -429,6 +597,23 @@ public final ListSessionsPagedResponse listSessions(String database) {
/**
* Lists all sessions in a given database.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ListSessionsRequest request =
+ * ListSessionsRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * for (Session element : spannerClient.listSessions(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -441,6 +626,23 @@ public final ListSessionsPagedResponse listSessions(ListSessionsRequest request)
* Lists all sessions in a given database.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ListSessionsRequest request =
+ * ListSessionsRequest.newBuilder()
+ * .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ApiFuture future = spannerClient.listSessionsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Session element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable
listSessionsPagedCallable() {
@@ -452,6 +654,23 @@ public final ListSessionsPagedResponse listSessions(ListSessionsRequest request)
* Lists all sessions in a given database.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * while (true) {
+ * ListSessionsResponse response = spannerClient.listSessionsCallable().call(request);
+ * for (Session element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable listSessionsCallable() {
return stub.listSessionsCallable();
@@ -462,6 +681,15 @@ public final UnaryCallable listSessio
* Ends a session, releasing server resources associated with it. This will asynchronously trigger
* cancellation of any operations that are running with this session.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+ * spannerClient.deleteSession(name);
+ * }
+ * }
+ *
* @param name Required. The name of the session to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -476,6 +704,15 @@ public final void deleteSession(SessionName name) {
* Ends a session, releasing server resources associated with it. This will asynchronously trigger
* cancellation of any operations that are running with this session.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+ * spannerClient.deleteSession(name);
+ * }
+ * }
+ *
* @param name Required. The name of the session to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -489,6 +726,19 @@ public final void deleteSession(String name) {
* Ends a session, releasing server resources associated with it. This will asynchronously trigger
* cancellation of any operations that are running with this session.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DeleteSessionRequest request =
+ * DeleteSessionRequest.newBuilder()
+ * .setName(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .build();
+ * spannerClient.deleteSession(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -502,6 +752,19 @@ public final void deleteSession(DeleteSessionRequest request) {
* cancellation of any operations that are running with this session.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DeleteSessionRequest request =
+ * DeleteSessionRequest.newBuilder()
+ * .setName(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .build();
+ * ApiFuture future = spannerClient.deleteSessionCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallable deleteSessionCallable() {
return stub.deleteSessionCallable();
@@ -520,6 +783,27 @@ public final UnaryCallable deleteSessionCallable()
* Larger result sets can be fetched in streaming fashion by calling
* [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ExecuteSqlRequest request =
+ * ExecuteSqlRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setSql("sql114126")
+ * .setParams(Struct.newBuilder().build())
+ * .putAllParamTypes(new HashMap())
+ * .setResumeToken(ByteString.EMPTY)
+ * .setPartitionToken(ByteString.EMPTY)
+ * .setSeqno(109325920)
+ * .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
+ * .build();
+ * ResultSet response = spannerClient.executeSql(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -541,6 +825,27 @@ public final ResultSet executeSql(ExecuteSqlRequest request) {
* [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ExecuteSqlRequest request =
+ * ExecuteSqlRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setSql("sql114126")
+ * .setParams(Struct.newBuilder().build())
+ * .putAllParamTypes(new HashMap())
+ * .setResumeToken(ByteString.EMPTY)
+ * .setPartitionToken(ByteString.EMPTY)
+ * .setSeqno(109325920)
+ * .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future = spannerClient.executeSqlCallable().futureCall(request);
+ * // Do something.
+ * ResultSet response = future.get();
+ * }
+ * }
*/
public final UnaryCallable executeSqlCallable() {
return stub.executeSqlCallable();
@@ -554,6 +859,29 @@ public final UnaryCallable executeSqlCallable() {
* MiB, and no column value can exceed 10 MiB.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ExecuteSqlRequest request =
+ * ExecuteSqlRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setSql("sql114126")
+ * .setParams(Struct.newBuilder().build())
+ * .putAllParamTypes(new HashMap())
+ * .setResumeToken(ByteString.EMPTY)
+ * .setPartitionToken(ByteString.EMPTY)
+ * .setSeqno(109325920)
+ * .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
+ * .build();
+ * ServerStream stream =
+ * spannerClient.executeStreamingSqlCallable().call(request);
+ * for (PartialResultSet response : stream) {
+ * // Do something when a response is received.
+ * }
+ * }
+ * }
*/
public final ServerStreamingCallable
executeStreamingSqlCallable() {
@@ -573,6 +901,22 @@ public final UnaryCallable executeSqlCallable() {
*
* Execution stops after the first failed statement; the remaining statements are not executed.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ExecuteBatchDmlRequest request =
+ * ExecuteBatchDmlRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .addAllStatements(new ArrayList())
+ * .setSeqno(109325920)
+ * .build();
+ * ExecuteBatchDmlResponse response = spannerClient.executeBatchDml(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -594,6 +938,23 @@ public final ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest requ
* Execution stops after the first failed statement; the remaining statements are not executed.
*
*
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ExecuteBatchDmlRequest request =
+ * ExecuteBatchDmlRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .addAllStatements(new ArrayList())
+ * .setSeqno(109325920)
+ * .build();
+ * ApiFuture future =
+ * spannerClient.executeBatchDmlCallable().futureCall(request);
+ * // Do something.
+ * ExecuteBatchDmlResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable
executeBatchDmlCallable() {
@@ -614,6 +975,27 @@ public final ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest requ
* Larger result sets can be yielded in streaming fashion by calling
* [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ReadRequest request =
+ * ReadRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setTable("table110115790")
+ * .setIndex("index100346066")
+ * .addAllColumns(new ArrayList())
+ * .setKeySet(KeySet.newBuilder().build())
+ * .setLimit(102976443)
+ * .setResumeToken(ByteString.EMPTY)
+ * .setPartitionToken(ByteString.EMPTY)
+ * .build();
+ * ResultSet response = spannerClient.read(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -636,6 +1018,27 @@ public final ResultSet read(ReadRequest request) {
* [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ReadRequest request =
+ * ReadRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setTable("table110115790")
+ * .setIndex("index100346066")
+ * .addAllColumns(new ArrayList())
+ * .setKeySet(KeySet.newBuilder().build())
+ * .setLimit(102976443)
+ * .setResumeToken(ByteString.EMPTY)
+ * .setPartitionToken(ByteString.EMPTY)
+ * .build();
+ * ApiFuture future = spannerClient.readCallable().futureCall(request);
+ * // Do something.
+ * ResultSet response = future.get();
+ * }
+ * }
*/
public final UnaryCallable readCallable() {
return stub.readCallable();
@@ -649,6 +1052,28 @@ public final UnaryCallable readCallable() {
* exceed 10 MiB.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * ReadRequest request =
+ * ReadRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setTable("table110115790")
+ * .setIndex("index100346066")
+ * .addAllColumns(new ArrayList())
+ * .setKeySet(KeySet.newBuilder().build())
+ * .setLimit(102976443)
+ * .setResumeToken(ByteString.EMPTY)
+ * .setPartitionToken(ByteString.EMPTY)
+ * .build();
+ * ServerStream stream = spannerClient.streamingReadCallable().call(request);
+ * for (PartialResultSet response : stream) {
+ * // Do something when a response is received.
+ * }
+ * }
+ * }
*/
public final ServerStreamingCallable streamingReadCallable() {
return stub.streamingReadCallable();
@@ -660,6 +1085,16 @@ public final ServerStreamingCallable streamingRea
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+ * TransactionOptions options = TransactionOptions.newBuilder().build();
+ * Transaction response = spannerClient.beginTransaction(session, options);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction runs.
* @param options Required. Options for the new transaction.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -679,6 +1114,17 @@ public final Transaction beginTransaction(SessionName session, TransactionOption
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String session =
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+ * TransactionOptions options = TransactionOptions.newBuilder().build();
+ * Transaction response = spannerClient.beginTransaction(session, options);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction runs.
* @param options Required. Options for the new transaction.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -695,6 +1141,20 @@ public final Transaction beginTransaction(String session, TransactionOptions opt
* [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * BeginTransactionRequest request =
+ * BeginTransactionRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setOptions(TransactionOptions.newBuilder().build())
+ * .build();
+ * Transaction response = spannerClient.beginTransaction(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -709,6 +1169,20 @@ public final Transaction beginTransaction(BeginTransactionRequest request) {
* [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * BeginTransactionRequest request =
+ * BeginTransactionRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setOptions(TransactionOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future = spannerClient.beginTransactionCallable().futureCall(request);
+ * // Do something.
+ * Transaction response = future.get();
+ * }
+ * }
*/
public final UnaryCallable beginTransactionCallable() {
return stub.beginTransactionCallable();
@@ -729,6 +1203,17 @@ public final UnaryCallable beginTransactio
* track of the transaction outcome and we recommend that you perform another read from the
* database to see the state of things as they are now.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+ * ByteString transactionId = ByteString.EMPTY;
+ * List mutations = new ArrayList<>();
+ * CommitResponse response = spannerClient.commit(session, transactionId, mutations);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction to be committed is running.
* @param transactionId Commit a previously-started transaction.
* @param mutations The mutations to be executed when this transaction commits. All mutations are
@@ -761,6 +1246,17 @@ public final CommitResponse commit(
* track of the transaction outcome and we recommend that you perform another read from the
* database to see the state of things as they are now.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+ * TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
+ * List mutations = new ArrayList<>();
+ * CommitResponse response = spannerClient.commit(session, singleUseTransaction, mutations);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction to be committed is running.
* @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike
* commit of a previously-started transaction, commit with a temporary transaction is
@@ -799,6 +1295,18 @@ public final CommitResponse commit(
* track of the transaction outcome and we recommend that you perform another read from the
* database to see the state of things as they are now.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String session =
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+ * ByteString transactionId = ByteString.EMPTY;
+ * List mutations = new ArrayList<>();
+ * CommitResponse response = spannerClient.commit(session, transactionId, mutations);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction to be committed is running.
* @param transactionId Commit a previously-started transaction.
* @param mutations The mutations to be executed when this transaction commits. All mutations are
@@ -831,6 +1339,18 @@ public final CommitResponse commit(
* track of the transaction outcome and we recommend that you perform another read from the
* database to see the state of things as they are now.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String session =
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+ * TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
+ * List mutations = new ArrayList<>();
+ * CommitResponse response = spannerClient.commit(session, singleUseTransaction, mutations);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction to be committed is running.
* @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike
* commit of a previously-started transaction, commit with a temporary transaction is
@@ -869,6 +1389,21 @@ public final CommitResponse commit(
* track of the transaction outcome and we recommend that you perform another read from the
* database to see the state of things as they are now.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * CommitRequest request =
+ * CommitRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .addAllMutations(new ArrayList())
+ * .setReturnCommitStats(true)
+ * .build();
+ * CommitResponse response = spannerClient.commit(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -892,6 +1427,21 @@ public final CommitResponse commit(CommitRequest request) {
* database to see the state of things as they are now.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * CommitRequest request =
+ * CommitRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .addAllMutations(new ArrayList())
+ * .setReturnCommitStats(true)
+ * .build();
+ * ApiFuture future = spannerClient.commitCallable().futureCall(request);
+ * // Do something.
+ * CommitResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable commitCallable() {
return stub.commitCallable();
@@ -907,6 +1457,16 @@ public final UnaryCallable commitCallable() {
* `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was
* already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+ * ByteString transactionId = ByteString.EMPTY;
+ * spannerClient.rollback(session, transactionId);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction to roll back is running.
* @param transactionId Required. The transaction to roll back.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -930,6 +1490,17 @@ public final void rollback(SessionName session, ByteString transactionId) {
* `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was
* already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * String session =
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+ * ByteString transactionId = ByteString.EMPTY;
+ * spannerClient.rollback(session, transactionId);
+ * }
+ * }
+ *
* @param session Required. The session in which the transaction to roll back is running.
* @param transactionId Required. The transaction to roll back.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -950,6 +1521,20 @@ public final void rollback(String session, ByteString transactionId) {
* `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was
* already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
*
+ *
Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * RollbackRequest request =
+ * RollbackRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransactionId(ByteString.EMPTY)
+ * .build();
+ * spannerClient.rollback(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -968,6 +1553,20 @@ public final void rollback(RollbackRequest request) {
* already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * RollbackRequest request =
+ * RollbackRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransactionId(ByteString.EMPTY)
+ * .build();
+ * ApiFuture future = spannerClient.rollbackCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallable rollbackCallable() {
return stub.rollbackCallable();
@@ -986,6 +1585,24 @@ public final UnaryCallable rollbackCallable() {
* too long, begins a new transaction, or becomes too old. When any of these happen, it is not
* possible to resume the query, and the whole operation must be restarted from the beginning.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * PartitionQueryRequest request =
+ * PartitionQueryRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setSql("sql114126")
+ * .setParams(Struct.newBuilder().build())
+ * .putAllParamTypes(new HashMap())
+ * .setPartitionOptions(PartitionOptions.newBuilder().build())
+ * .build();
+ * PartitionResponse response = spannerClient.partitionQuery(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1007,6 +1624,25 @@ public final PartitionResponse partitionQuery(PartitionQueryRequest request) {
* possible to resume the query, and the whole operation must be restarted from the beginning.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * PartitionQueryRequest request =
+ * PartitionQueryRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setSql("sql114126")
+ * .setParams(Struct.newBuilder().build())
+ * .putAllParamTypes(new HashMap())
+ * .setPartitionOptions(PartitionOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * spannerClient.partitionQueryCallable().futureCall(request);
+ * // Do something.
+ * PartitionResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable partitionQueryCallable() {
return stub.partitionQueryCallable();
@@ -1026,6 +1662,25 @@ public final UnaryCallable partitionQu
* too long, begins a new transaction, or becomes too old. When any of these happen, it is not
* possible to resume the read, and the whole operation must be restarted from the beginning.
*
+ * Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * PartitionReadRequest request =
+ * PartitionReadRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setTable("table110115790")
+ * .setIndex("index100346066")
+ * .addAllColumns(new ArrayList())
+ * .setKeySet(KeySet.newBuilder().build())
+ * .setPartitionOptions(PartitionOptions.newBuilder().build())
+ * .build();
+ * PartitionResponse response = spannerClient.partitionRead(request);
+ * }
+ * }
+ *
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@@ -1048,6 +1703,26 @@ public final PartitionResponse partitionRead(PartitionReadRequest request) {
* possible to resume the read, and the whole operation must be restarted from the beginning.
*
* Sample code:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * PartitionReadRequest request =
+ * PartitionReadRequest.newBuilder()
+ * .setSession(
+ * SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+ * .setTransaction(TransactionSelector.newBuilder().build())
+ * .setTable("table110115790")
+ * .setIndex("index100346066")
+ * .addAllColumns(new ArrayList())
+ * .setKeySet(KeySet.newBuilder().build())
+ * .setPartitionOptions(PartitionOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * spannerClient.partitionReadCallable().futureCall(request);
+ * // Do something.
+ * PartitionResponse response = future.get();
+ * }
+ * }
*/
public final UnaryCallable partitionReadCallable() {
return stub.partitionReadCallable();
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java
index 7e442cc8b47..0f340c9469a 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java
@@ -25,6 +25,13 @@
* in Cloud Spanner databases.
*
* Sample for SpannerClient:
+ *
+ *
{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ * DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ * Session response = spannerClient.createSession(database);
+ * }
+ * }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.spanner.v1;
diff --git a/synth.metadata b/synth.metadata
index 7e28947f74e..ec08e646e16 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,15 +4,15 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "2887bbb77141ddc92d8ef79d6221a041b4330999"
+ "sha": "58cebd85a9d82bd1526b9eae98892181f1a022f1"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
- "sha": "30eb779ddcc4f389df34d0802d081ef6c4559d6d",
- "internalRef": "354462069"
+ "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb",
+ "internalRef": "356341083"
}
},
{
From a63924b088c54962bf963ab9e27fa92c8b090227 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Wed, 10 Feb 2021 09:00:13 -0800
Subject: [PATCH 31/42] build(java): update autorelease script (#863)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/d3b31218-a85c-4976-9854-6b0543a40737/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/2414b817065726eae0bc525346c7e874f969369d
---
.github/workflows/auto-release.yaml | 4 ++--
synth.metadata | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/.github/workflows/auto-release.yaml b/.github/workflows/auto-release.yaml
index 76e6404b4e0..7c8816a7d7b 100644
--- a/.github/workflows/auto-release.yaml
+++ b/.github/workflows/auto-release.yaml
@@ -4,7 +4,7 @@ name: auto-release
jobs:
approve:
runs-on: ubuntu-latest
- if: contains(github.head_ref, 'release-v')
+ if: contains(github.head_ref, 'release-please')
steps:
- uses: actions/github-script@v3
with:
@@ -16,7 +16,7 @@ jobs:
return;
}
- // only approve PRs like "chore: release "
+ // only approve PRs like "chore(master): release "
if ( !context.payload.pull_request.title.startsWith("chore(master): release") ) {
return;
}
diff --git a/synth.metadata b/synth.metadata
index ec08e646e16..d7cc91b54ba 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "58cebd85a9d82bd1526b9eae98892181f1a022f1"
+ "sha": "7cdfb82b40487600547d0bad92119508161ca689"
}
},
{
@@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "692715c0f23a7bb3bfbbaa300f7620ddfa8c47e5"
+ "sha": "2414b817065726eae0bc525346c7e874f969369d"
}
}
],
From 54cfa0f70f9b117ff50310adc5e01282e4bd82ed Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Wed, 10 Feb 2021 09:38:07 -0800
Subject: [PATCH 32/42] chore: regenerate README (#864)
This PR was generated using Autosynth. :rainbow:
Log from Synthtool
```
2021-02-10 17:02:29,334 synthtool [DEBUG] > Executing /root/.cache/synthtool/java-spanner/.github/readme/synth.py.
On branch autosynth-readme
nothing to commit, working tree clean
2021-02-10 17:02:30,304 synthtool [DEBUG] > Wrote metadata to .github/readme/synth.metadata/synth.metadata.
```
Full log will be available here:
https://source.cloud.google.com/results/invocations/fdf98902-6041-43f0-8695-ea336573ec53/targets
- [ ] To automatically regenerate this PR, check this box.
---
.github/readme/synth.metadata/synth.metadata | 4 ++--
README.md | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/readme/synth.metadata/synth.metadata b/.github/readme/synth.metadata/synth.metadata
index 54018735ad9..fb9390e2e28 100644
--- a/.github/readme/synth.metadata/synth.metadata
+++ b/.github/readme/synth.metadata/synth.metadata
@@ -4,14 +4,14 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "fadb4011e554d0554332ac47e1c0060afca9ffeb"
+ "sha": "a63924b088c54962bf963ab9e27fa92c8b090227"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "56ddc68f36b32341e9f22c2c59b4ce6aa3ba635f"
+ "sha": "2414b817065726eae0bc525346c7e874f969369d"
}
}
]
diff --git a/README.md b/README.md
index 1ddee68fa74..0fc145b29b7 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ If you are using Maven without BOM, add this to your dependencies:
If you are using Gradle 5.x or later, add this to your dependencies
```Groovy
-implementation platform('com.google.cloud:libraries-bom:16.3.0')
+implementation platform('com.google.cloud:libraries-bom:16.4.0')
compile 'com.google.cloud:google-cloud-spanner'
```
From a36be4c02d26c29c6ee52c6dd5e5f40b3728f91d Mon Sep 17 00:00:00 2001
From: WhiteSource Renovate
Date: Mon, 15 Feb 2021 07:08:30 +0100
Subject: [PATCH 33/42] test(deps): update dependency junit:junit to v4.13.2
(#870)
---
pom.xml | 2 +-
samples/install-without-bom/pom.xml | 2 +-
samples/snapshot/pom.xml | 2 +-
samples/snippets/pom.xml | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/pom.xml b/pom.xml
index 48a162429e7..7a1418ae958 100644
--- a/pom.xml
+++ b/pom.xml
@@ -115,7 +115,7 @@
junit
junit
- 4.13.1
+ 4.13.2
test
diff --git a/samples/install-without-bom/pom.xml b/samples/install-without-bom/pom.xml
index 5373c065550..b9c60d3097b 100644
--- a/samples/install-without-bom/pom.xml
+++ b/samples/install-without-bom/pom.xml
@@ -93,7 +93,7 @@
junit
junit
- 4.13.1
+ 4.13.2
test
diff --git a/samples/snapshot/pom.xml b/samples/snapshot/pom.xml
index e66974d9002..5bbf704d5f1 100644
--- a/samples/snapshot/pom.xml
+++ b/samples/snapshot/pom.xml
@@ -92,7 +92,7 @@
junit
junit
- 4.13.1
+ 4.13.2
test
diff --git a/samples/snippets/pom.xml b/samples/snippets/pom.xml
index 8fbf7b1b9e2..5f5f19943e5 100644
--- a/samples/snippets/pom.xml
+++ b/samples/snippets/pom.xml
@@ -104,7 +104,7 @@
junit
junit
- 4.13.1
+ 4.13.2
test
From 5af36739532037360dfd504a4a0988562550526c Mon Sep 17 00:00:00 2001
From: Elliotte Rusty Harold
Date: Tue, 16 Feb 2021 13:40:02 +0000
Subject: [PATCH 34/42] docs: libraries-bom 16.4.0 (#867)
@suztomo
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 0fc145b29b7..f35503e755a 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
com.google.cloud
libraries-bom
- 16.3.0
+ 16.4.0
pom
import
From 2b2a964e0c3605950112a3c3a35e32dca09f9de3 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Tue, 16 Feb 2021 06:20:02 -0800
Subject: [PATCH 35/42] chore: regenerate README (#873)
This PR was generated using Autosynth. :rainbow:
Log from Synthtool
```
2021-02-16 13:42:20,405 synthtool [DEBUG] > Executing /root/.cache/synthtool/java-spanner/.github/readme/synth.py.
On branch autosynth-readme
nothing to commit, working tree clean
2021-02-16 13:42:21,947 synthtool [DEBUG] > Wrote metadata to .github/readme/synth.metadata/synth.metadata.
```
Full log will be available here:
https://source.cloud.google.com/results/invocations/172c4d83-9ece-4a07-b9d5-dbbe07c16651/targets
- [ ] To automatically regenerate this PR, check this box.
---
.github/readme/synth.metadata/synth.metadata | 4 ++--
README.md | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/readme/synth.metadata/synth.metadata b/.github/readme/synth.metadata/synth.metadata
index fb9390e2e28..d295adb59e8 100644
--- a/.github/readme/synth.metadata/synth.metadata
+++ b/.github/readme/synth.metadata/synth.metadata
@@ -4,14 +4,14 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "a63924b088c54962bf963ab9e27fa92c8b090227"
+ "sha": "5af36739532037360dfd504a4a0988562550526c"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "2414b817065726eae0bc525346c7e874f969369d"
+ "sha": "b32c87d2c087fb2a841acc623ab540105de821af"
}
}
]
diff --git a/README.md b/README.md
index f35503e755a..0fc145b29b7 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
com.google.cloud
libraries-bom
- 16.4.0
+ 16.3.0
pom
import
From 3f5351df6d13bd3bc3639e8a75e24ae924a4cfec Mon Sep 17 00:00:00 2001
From: WhiteSource Renovate
Date: Tue, 16 Feb 2021 15:54:28 +0100
Subject: [PATCH 36/42] chore(deps): update dependency
com.google.cloud:libraries-bom to v16.4.0 (#861)
---
samples/snippets/pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/samples/snippets/pom.xml b/samples/snippets/pom.xml
index 5f5f19943e5..642eec6ea62 100644
--- a/samples/snippets/pom.xml
+++ b/samples/snippets/pom.xml
@@ -33,7 +33,7 @@
com.google.cloud
libraries-bom
- 16.3.0
+ 16.4.0
pom
import
From 326b8331d952005cf48eaa9efb054fab5918f7e9 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Tue, 16 Feb 2021 07:28:02 -0800
Subject: [PATCH 37/42] chore: regenerate README (#876)
This PR was generated using Autosynth. :rainbow:
Log from Synthtool
```
2021-02-16 14:56:36,897 synthtool [DEBUG] > Executing /root/.cache/synthtool/java-spanner/.github/readme/synth.py.
On branch autosynth-readme
nothing to commit, working tree clean
2021-02-16 14:56:38,474 synthtool [DEBUG] > Wrote metadata to .github/readme/synth.metadata/synth.metadata.
```
Full log will be available here:
https://source.cloud.google.com/results/invocations/6601876f-4193-4e02-be31-8c69bfbabd58/targets
- [ ] To automatically regenerate this PR, check this box.
---
.github/readme/synth.metadata/synth.metadata | 2 +-
README.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/readme/synth.metadata/synth.metadata b/.github/readme/synth.metadata/synth.metadata
index d295adb59e8..dfef9855f54 100644
--- a/.github/readme/synth.metadata/synth.metadata
+++ b/.github/readme/synth.metadata/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "5af36739532037360dfd504a4a0988562550526c"
+ "sha": "3f5351df6d13bd3bc3639e8a75e24ae924a4cfec"
}
},
{
diff --git a/README.md b/README.md
index 0fc145b29b7..f35503e755a 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
com.google.cloud
libraries-bom
- 16.3.0
+ 16.4.0
pom
import
From 5e07e4e12f08acc6a1491f7aa67cd289c54136bd Mon Sep 17 00:00:00 2001
From: Yoshi Automation Bot
Date: Tue, 16 Feb 2021 16:18:20 -0800
Subject: [PATCH 38/42] ci: linkage monitor CI job to use build.sh (#878)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/96c62e92-13ae-4f3c-9727-c854ec8b7488/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/f327d3b657a63ae4a8efd7f011a15eacae36b59c
---
.github/workflows/ci.yaml | 13 +++----------
synth.metadata | 4 ++--
2 files changed, 5 insertions(+), 12 deletions(-)
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 98a472e132d..def8b3a2c84 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -55,17 +55,10 @@ jobs:
java-version: 8
- run: java -version
- name: Install artifacts to local Maven repository
- run: |
- source .kokoro/common.sh
- retry_with_backoff 3 10 \
- mvn install -B -V \
- -Dmaven.test.skip -DskipTests=true \
- -Dclirr.skip=true \
- -Denforcer.skip=true \
- -Dmaven.javadoc.skip=true \
- -Dgcloud.download.skip=true
+ run: .kokoro/build.sh
shell: bash
- - uses: GoogleCloudPlatform/cloud-opensource-java/linkage-monitor@v1-linkagemonitor
+ - name: Validate any conflicts with regard to com.google.cloud:libraries-bom (latest release)
+ uses: GoogleCloudPlatform/cloud-opensource-java/linkage-monitor@v1-linkagemonitor
lint:
runs-on: ubuntu-latest
steps:
diff --git a/synth.metadata b/synth.metadata
index d7cc91b54ba..016c9d8aef1 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-spanner.git",
- "sha": "7cdfb82b40487600547d0bad92119508161ca689"
+ "sha": "326b8331d952005cf48eaa9efb054fab5918f7e9"
}
},
{
@@ -19,7 +19,7 @@
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
- "sha": "2414b817065726eae0bc525346c7e874f969369d"
+ "sha": "f327d3b657a63ae4a8efd7f011a15eacae36b59c"
}
}
],
From 44aa384429056dd6c6563351c43fe7dcac451008 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?=
Date: Wed, 17 Feb 2021 04:20:11 +0100
Subject: [PATCH 39/42] feat!: add support for CommitStats (#544)
* feat!: add support for CommitStats
Adds support for returning CommitStats from read/write transactions.
* fix: add clirr ignored differences
* fix: error message should start with getCommitResponse
Co-authored-by: skuruppu
* fix: remove overload delay
* chore: cleanup after merge
* fix: update copyright years of new files
* test: fix flaky test
* test: skip commit stats tests on emulator
* test: missed one commit stats tests against emulator
* test: skip another emulator test
* test: add missing test cases
* fix: address review comments
* chore: use junit assertion instead of truth
* chore: replace truth asserts with junit asserts
* chore: replace truth assertions with junit
* chore: cleanup test and variable names
* fix: rename test method and variables
* fix: address review comments
Co-authored-by: skuruppu
---
.../clirr-ignored-differences.xml | 23 +++
.../com/google/cloud/spanner/AsyncRunner.java | 6 +
.../google/cloud/spanner/AsyncRunnerImpl.java | 36 +++-
.../spanner/AsyncTransactionManager.java | 3 +
.../spanner/AsyncTransactionManagerImpl.java | 30 +++-
.../google/cloud/spanner/CommitResponse.java | 30 +++-
.../com/google/cloud/spanner/CommitStats.java | 54 ++++++
.../com/google/cloud/spanner/Options.java | 29 +++-
.../com/google/cloud/spanner/SessionImpl.java | 20 +--
.../com/google/cloud/spanner/SessionPool.java | 41 ++++-
.../SessionPoolAsyncTransactionManager.java | 18 ++
.../cloud/spanner/TransactionManager.java | 3 +
.../cloud/spanner/TransactionManagerImpl.java | 10 +-
.../cloud/spanner/TransactionRunner.java | 3 +
.../cloud/spanner/TransactionRunnerImpl.java | 47 +++---
.../cloud/spanner/AsyncRunnerImplTest.java | 156 ++++++++++++++++++
.../google/cloud/spanner/AsyncRunnerTest.java | 24 +++
.../AsyncTransactionManagerImplTest.java | 53 ++++++
.../spanner/AsyncTransactionManagerTest.java | 28 ++++
.../cloud/spanner/BaseSessionPoolTest.java | 5 +-
.../cloud/spanner/CommitResponseTest.java | 86 ++++++++++
.../cloud/spanner/DatabaseClientImplTest.java | 139 +++++++++++++---
.../spanner/InlineBeginTransactionTest.java | 8 +-
.../cloud/spanner/MockSpannerServiceImpl.java | 12 +-
.../com/google/cloud/spanner/OptionsTest.java | 55 +++++-
.../RetryOnInvalidatedSessionTest.java | 13 +-
.../google/cloud/spanner/SessionPoolTest.java | 22 ++-
.../spanner/TransactionContextImplTest.java | 34 ++++
.../spanner/TransactionManagerImplTest.java | 20 +--
.../spanner/TransactionRunnerImplTest.java | 6 +-
.../connection/ConnectionImplTest.java | 29 +++-
.../connection/ReadWriteTransactionTest.java | 11 +-
.../connection/SingleUseTransactionTest.java | 28 +++-
.../cloud/spanner/it/ITAsyncAPITest.java | 89 +++++++++-
.../spanner/it/ITTransactionManagerTest.java | 29 ++++
.../cloud/spanner/it/ITTransactionTest.java | 22 +++
.../google/cloud/spanner/it/ITWriteTest.java | 42 +++++
37 files changed, 1111 insertions(+), 153 deletions(-)
create mode 100644 google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitStats.java
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncRunnerImplTest.java
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncTransactionManagerImplTest.java
create mode 100644 google-cloud-spanner/src/test/java/com/google/cloud/spanner/CommitResponseTest.java
diff --git a/google-cloud-spanner/clirr-ignored-differences.xml b/google-cloud-spanner/clirr-ignored-differences.xml
index 8dd5d9dad6d..fcafcb7c3a1 100644
--- a/google-cloud-spanner/clirr-ignored-differences.xml
+++ b/google-cloud-spanner/clirr-ignored-differences.xml
@@ -453,4 +453,27 @@
com/google/cloud/spanner/TransactionContext
com.google.api.core.ApiFuture executeUpdateAsync(com.google.cloud.spanner.Statement)
+
+
+
+ 7012
+ com/google/cloud/spanner/AsyncTransactionManager
+ com.google.api.core.ApiFuture getCommitResponse()
+
+
+ 7012
+ com/google/cloud/spanner/AsyncRunner
+ com.google.api.core.ApiFuture getCommitResponse()
+
+
+ 7012
+ com/google/cloud/spanner/TransactionManager
+ com.google.cloud.spanner.CommitResponse getCommitResponse()
+
+
+ 7012
+ com/google/cloud/spanner/TransactionRunner
+ com.google.cloud.spanner.CommitResponse getCommitResponse()
+
+
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunner.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunner.java
index 3cae49e65b4..c9dec98d55d 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunner.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunner.java
@@ -56,4 +56,10 @@ interface AsyncWork {
* {@link ExecutionException} if the transaction did not commit.
*/
ApiFuture getCommitTimestamp();
+
+ /**
+ * Returns the {@link CommitResponse} of this transaction. {@link ApiFuture#get()} throws an
+ * {@link ExecutionException} if the transaction did not commit.
+ */
+ ApiFuture getCommitResponse();
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunnerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunnerImpl.java
index 5b83402919e..7982f0d2822 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunnerImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunnerImpl.java
@@ -16,23 +16,31 @@
package com.google.cloud.spanner;
+import static com.google.common.base.Preconditions.checkState;
+
+import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
+import com.google.api.core.ApiFutures;
import com.google.api.core.SettableApiFuture;
import com.google.cloud.Timestamp;
import com.google.cloud.spanner.TransactionRunner.TransactionCallable;
+import com.google.common.base.Preconditions;
+import com.google.common.util.concurrent.MoreExecutors;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
class AsyncRunnerImpl implements AsyncRunner {
private final TransactionRunnerImpl delegate;
- private final SettableApiFuture commitTimestamp = SettableApiFuture.create();
+ private SettableApiFuture commitResponse;
AsyncRunnerImpl(TransactionRunnerImpl delegate) {
- this.delegate = delegate;
+ this.delegate = Preconditions.checkNotNull(delegate);
}
@Override
public ApiFuture runAsync(final AsyncWork work, Executor executor) {
+ Preconditions.checkState(commitResponse == null, "runAsync() can only be called once");
+ commitResponse = SettableApiFuture.create();
final SettableApiFuture res = SettableApiFuture.create();
executor.execute(
new Runnable() {
@@ -43,7 +51,7 @@ public void run() {
} catch (Throwable t) {
res.setException(t);
} finally {
- setCommitTimestamp();
+ setCommitResponse();
}
}
});
@@ -66,16 +74,30 @@ public R run(TransactionContext transaction) throws Exception {
});
}
- private void setCommitTimestamp() {
+ private void setCommitResponse() {
try {
- commitTimestamp.set(delegate.getCommitTimestamp());
+ commitResponse.set(delegate.getCommitResponse());
} catch (Throwable t) {
- commitTimestamp.setException(t);
+ commitResponse.setException(t);
}
}
@Override
public ApiFuture getCommitTimestamp() {
- return commitTimestamp;
+ checkState(commitResponse != null, "runAsync() has not yet been called");
+ return ApiFutures.transform(
+ commitResponse,
+ new ApiFunction() {
+ @Override
+ public Timestamp apply(CommitResponse input) {
+ return input.getCommitTimestamp();
+ }
+ },
+ MoreExecutors.directExecutor());
+ }
+
+ public ApiFuture getCommitResponse() {
+ checkState(commitResponse != null, "runAsync() has not yet been called");
+ return commitResponse;
}
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManager.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManager.java
index 02d4a9dbd23..a4741dd3293 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManager.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManager.java
@@ -191,6 +191,9 @@ public interface AsyncTransactionFunction {
/** Returns the state of the transaction. */
TransactionState getState();
+ /** Returns the {@link CommitResponse} of this transaction. */
+ ApiFuture getCommitResponse();
+
/**
* Closes the manager. If there is an active transaction, it will be rolled back. Underlying
* session will be released back to the session pool.
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManagerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManagerImpl.java
index 8dab813015e..2ec914c24aa 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManagerImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncTransactionManagerImpl.java
@@ -17,6 +17,7 @@
package com.google.cloud.spanner;
import com.google.api.core.ApiAsyncFunction;
+import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutureCallback;
import com.google.api.core.ApiFutures;
@@ -45,7 +46,7 @@ final class AsyncTransactionManagerImpl
private TransactionRunnerImpl.TransactionContextImpl txn;
private TransactionState txnState;
- private final SettableApiFuture commitTimestamp = SettableApiFuture.create();
+ private final SettableApiFuture commitResponse = SettableApiFuture.create();
AsyncTransactionManagerImpl(SessionImpl session, Span span, TransactionOption... options) {
this.session = session;
@@ -132,29 +133,37 @@ public ApiFuture commitAsync() {
SpannerExceptionFactory.newSpannerException(
ErrorCode.ABORTED, "Transaction already aborted"));
}
- ApiFuture res = txn.commitAsync();
+ ApiFuture commitResponseFuture = txn.commitAsync();
txnState = TransactionState.COMMITTED;
ApiFutures.addCallback(
- res,
- new ApiFutureCallback() {
+ commitResponseFuture,
+ new ApiFutureCallback() {
@Override
public void onFailure(Throwable t) {
if (t instanceof AbortedException) {
txnState = TransactionState.ABORTED;
} else {
txnState = TransactionState.COMMIT_FAILED;
- commitTimestamp.setException(t);
+ commitResponse.setException(t);
}
}
@Override
- public void onSuccess(Timestamp result) {
- commitTimestamp.set(result);
+ public void onSuccess(CommitResponse result) {
+ commitResponse.set(result);
+ }
+ },
+ MoreExecutors.directExecutor());
+ return ApiFutures.transform(
+ commitResponseFuture,
+ new ApiFunction() {
+ @Override
+ public Timestamp apply(CommitResponse input) {
+ return input.getCommitTimestamp();
}
},
MoreExecutors.directExecutor());
- return res;
}
@Override
@@ -187,6 +196,11 @@ public TransactionState getState() {
return txnState;
}
+ @Override
+ public ApiFuture getCommitResponse() {
+ return commitResponse;
+ }
+
@Override
public void invalidate() {
if (txnState == TransactionState.STARTED || txnState == null) {
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitResponse.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitResponse.java
index dd5534d7c35..00505cf8d1f 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitResponse.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitResponse.java
@@ -17,20 +17,38 @@
package com.google.cloud.spanner;
import com.google.cloud.Timestamp;
+import com.google.common.base.Preconditions;
import java.util.Objects;
/** Represents a response from a commit operation. */
public class CommitResponse {
- private final Timestamp commitTimestamp;
+ private final com.google.spanner.v1.CommitResponse proto;
public CommitResponse(Timestamp commitTimestamp) {
- this.commitTimestamp = commitTimestamp;
+ this.proto =
+ com.google.spanner.v1.CommitResponse.newBuilder()
+ .setCommitTimestamp(commitTimestamp.toProto())
+ .build();
}
- /** Returns a {@link Timestamp} representing the commit time of the write operation. */
+ CommitResponse(com.google.spanner.v1.CommitResponse proto) {
+ this.proto = Preconditions.checkNotNull(proto);
+ }
+
+ /** Returns a {@link Timestamp} representing the commit time of the transaction. */
public Timestamp getCommitTimestamp() {
- return commitTimestamp;
+ return Timestamp.fromProto(proto.getCommitTimestamp());
+ }
+
+ /**
+ * Commit statistics are returned by a read/write transaction if specifically requested by passing
+ * in {@link Options#commitStats()} to the transaction.
+ */
+ public CommitStats getCommitStats() {
+ Preconditions.checkState(
+ proto.hasCommitStats(), "The CommitResponse does not contain any commit statistics.");
+ return CommitStats.fromProto(proto.getCommitStats());
}
@Override
@@ -42,11 +60,11 @@ public boolean equals(Object o) {
return false;
}
CommitResponse that = (CommitResponse) o;
- return Objects.equals(commitTimestamp, that.commitTimestamp);
+ return Objects.equals(proto, that.proto);
}
@Override
public int hashCode() {
- return Objects.hash(commitTimestamp);
+ return Objects.hash(proto);
}
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitStats.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitStats.java
new file mode 100644
index 00000000000..eaf1a78819f
--- /dev/null
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/CommitStats.java
@@ -0,0 +1,54 @@
+/*
+ * 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.spanner;
+
+import com.google.common.base.Preconditions;
+
+/**
+ * Commit statistics are returned by a read/write transaction if specifically requested by passing
+ * in {@link Options#commitStats()} to the transaction.
+ */
+public class CommitStats {
+ private final long mutationCount;
+
+ private CommitStats(long mutationCount) {
+ this.mutationCount = mutationCount;
+ }
+
+ static CommitStats fromProto(com.google.spanner.v1.CommitResponse.CommitStats proto) {
+ Preconditions.checkNotNull(proto);
+ return new CommitStats(proto.getMutationCount());
+ }
+
+ /**
+ * The number of mutations that were executed by the transaction. Insert and update operations
+ * count with the multiplicity of the number of columns they affect. For example, inserting a new
+ * record may count as five mutations, if values are inserted into five columns. Delete and delete
+ * range operations count as one mutation regardless of the number of columns affected. Deleting a
+ * row from a parent table that has the ON DELETE CASCADE annotation is also counted as one
+ * mutation regardless of the number of interleaved child rows present. The exception to this is
+ * if there are secondary indexes defined on rows being deleted, then the changes to the secondary
+ * indexes are counted individually. For example, if a table has 2 secondary indexes, deleting a
+ * range of rows in the table counts as 1 mutation for the table, plus 2 mutations for each row
+ * that is deleted because the rows in the secondary index might be scattered over the key-space,
+ * making it impossible for Cloud Spanner to call a single delete range operation on the secondary
+ * indexes. Secondary indexes include the foreign keys backing indexes.
+ */
+ public long getMutationCount() {
+ return mutationCount;
+ }
+}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java
index 26d3cd68322..38932bf8a80 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java
@@ -46,6 +46,11 @@ public interface UpdateOption {}
/** Marker interface to mark options applicable to list operations in admin API. */
public interface ListOption {}
+ /** Specifying this instructs the transaction to request {@link CommitStats} from the backend. */
+ public static TransactionOption commitStats() {
+ return COMMIT_STATS_OPTION;
+ }
+
/**
* Specifying this will cause the read to yield at most this many rows. This should be greater
* than 0.
@@ -116,6 +121,16 @@ public static ListOption filter(String filter) {
return new FilterOption(filter);
}
+ /** Option to request {@link CommitStats} for read/write transactions. */
+ static final class CommitStatsOption extends InternalOption implements TransactionOption {
+ @Override
+ void appendToOptions(Options options) {
+ options.withCommitStats = true;
+ }
+ }
+
+ static final CommitStatsOption COMMIT_STATS_OPTION = new CommitStatsOption();
+
/** Option pertaining to flow control. */
static final class FlowControlOption extends InternalOption implements ReadAndQueryOption {
final int prefetchChunks;
@@ -143,6 +158,7 @@ void appendToOptions(Options options) {
}
}
+ private boolean withCommitStats;
private Long limit;
private Integer prefetchChunks;
private Integer bufferRows;
@@ -153,6 +169,10 @@ void appendToOptions(Options options) {
// Construction is via factory methods below.
private Options() {}
+ boolean withCommitStats() {
+ return withCommitStats;
+ }
+
boolean hasLimit() {
return limit != null;
}
@@ -204,6 +224,9 @@ String filter() {
@Override
public String toString() {
StringBuilder b = new StringBuilder();
+ if (withCommitStats) {
+ b.append("withCommitStats: ").append(withCommitStats).append(' ');
+ }
if (limit != null) {
b.append("limit: ").append(limit).append(' ');
}
@@ -234,7 +257,8 @@ public boolean equals(Object o) {
}
Options that = (Options) o;
- return (!hasLimit() && !that.hasLimit()
+ return Objects.equals(withCommitStats, that.withCommitStats)
+ && (!hasLimit() && !that.hasLimit()
|| hasLimit() && that.hasLimit() && Objects.equals(limit(), that.limit()))
&& (!hasPrefetchChunks() && !that.hasPrefetchChunks()
|| hasPrefetchChunks()
@@ -253,6 +277,9 @@ public boolean equals(Object o) {
@Override
public int hashCode() {
int result = 31;
+ if (withCommitStats) {
+ result = 31 * result + 1231;
+ }
if (limit != null) {
result = 31 * result + limit.hashCode();
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionImpl.java
index a20a6b7b248..51ec7b4d50d 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionImpl.java
@@ -147,7 +147,7 @@ public Void run(TransactionContext ctx) {
return null;
}
});
- return new CommitResponse(runner.getCommitTimestamp());
+ return runner.getCommitResponse();
}
@Override
@@ -165,6 +165,8 @@ public CommitResponse writeAtLeastOnceWithOptions(
final CommitRequest request =
CommitRequest.newBuilder()
.setSession(name)
+ .setReturnCommitStats(
+ Options.fromTransactionOptions(transactionOptions).withCommitStats())
.addAllMutations(mutationsProto)
.setSingleUseTransaction(
TransactionOptions.newBuilder()
@@ -174,11 +176,7 @@ public CommitResponse writeAtLeastOnceWithOptions(
try (Scope s = tracer.withSpan(span)) {
com.google.spanner.v1.CommitResponse response =
spanner.getRpc().commit(request, this.options);
- Timestamp t = Timestamp.fromProto(response.getCommitTimestamp());
- return new CommitResponse(t);
- } catch (IllegalArgumentException e) {
- TraceUtil.setWithFailure(span, e);
- throw newSpannerException(ErrorCode.INTERNAL, "Could not parse commit timestamp", e);
+ return new CommitResponse(response);
} catch (RuntimeException e) {
TraceUtil.setWithFailure(span, e);
throw e;
@@ -246,17 +244,12 @@ public ReadOnlyTransaction readOnlyTransaction(TimestampBound bound) {
@Override
public TransactionRunner readWriteTransaction(TransactionOption... options) {
- return setActive(
- new TransactionRunnerImpl(
- this, spanner.getRpc(), spanner.getDefaultPrefetchChunks(), options));
+ return setActive(new TransactionRunnerImpl(this, options));
}
@Override
public AsyncRunner runAsync(TransactionOption... options) {
- return new AsyncRunnerImpl(
- setActive(
- new TransactionRunnerImpl(
- this, spanner.getRpc(), spanner.getDefaultPrefetchChunks(), options)));
+ return new AsyncRunnerImpl(setActive(new TransactionRunnerImpl(this, options)));
}
@Override
@@ -350,6 +343,7 @@ public void run() {
TransactionContextImpl newTransaction(Options options) {
return TransactionContextImpl.newBuilder()
.setSession(this)
+ .setOptions(options)
.setTransactionId(readyTransactionId)
.setOptions(options)
.setTrackTransactionStarter(spanner.getOptions().isTrackTransactionStarter())
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java
index b24393340a4..51a42525bfc 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java
@@ -37,6 +37,7 @@
import static com.google.cloud.spanner.MetricRegistryConstants.SPANNER_LABEL_KEYS;
import static com.google.cloud.spanner.MetricRegistryConstants.SPANNER_LABEL_KEYS_WITH_TYPE;
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
+import static com.google.common.base.Preconditions.checkState;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
@@ -860,7 +861,7 @@ public TransactionContext resetForRetry() {
} catch (SessionNotFoundException e) {
session = sessionPool.replaceSession(e, session);
PooledSession pooledSession = session.get();
- delegate = pooledSession.delegate.transactionManager();
+ delegate = pooledSession.delegate.transactionManager(options);
restartedAfterSessionNotFound = true;
}
}
@@ -871,6 +872,11 @@ public Timestamp getCommitTimestamp() {
return delegate.getCommitTimestamp();
}
+ @Override
+ public CommitResponse getCommitResponse() {
+ return delegate.getCommitResponse();
+ }
+
@Override
public void close() {
if (closed) {
@@ -949,6 +955,11 @@ public Timestamp getCommitTimestamp() {
return getRunner().getCommitTimestamp();
}
+ @Override
+ public CommitResponse getCommitResponse() {
+ return getRunner().getCommitResponse();
+ }
+
@Override
public TransactionRunner allowNestedTransaction() {
getRunner().allowNestedTransaction();
@@ -960,7 +971,7 @@ private static class SessionPoolAsyncRunner implements AsyncRunner {
private final SessionPool sessionPool;
private volatile PooledSessionFuture session;
private final TransactionOption[] options;
- private final SettableApiFuture commitTimestamp = SettableApiFuture.create();
+ private SettableApiFuture commitResponse;
private SessionPoolAsyncRunner(
SessionPool sessionPool, PooledSessionFuture session, TransactionOption... options) {
@@ -971,6 +982,7 @@ private SessionPoolAsyncRunner(
@Override
public ApiFuture runAsync(final AsyncWork work, Executor executor) {
+ commitResponse = SettableApiFuture.create();
final SettableApiFuture res = SettableApiFuture.create();
executor.execute(
new Runnable() {
@@ -1010,7 +1022,7 @@ public void run() {
}
session.get().markUsed();
session.close();
- setCommitTimestamp(runner);
+ setCommitResponse(runner);
if (exception != null) {
res.setException(exception);
} else {
@@ -1021,17 +1033,32 @@ public void run() {
return res;
}
- private void setCommitTimestamp(AsyncRunner delegate) {
+ private void setCommitResponse(AsyncRunner delegate) {
try {
- commitTimestamp.set(delegate.getCommitTimestamp().get());
+ commitResponse.set(delegate.getCommitResponse().get());
} catch (Throwable t) {
- commitTimestamp.setException(t);
+ commitResponse.setException(t);
}
}
@Override
public ApiFuture getCommitTimestamp() {
- return commitTimestamp;
+ checkState(commitResponse != null, "runAsync() has not yet been called");
+ return ApiFutures.transform(
+ commitResponse,
+ new ApiFunction() {
+ @Override
+ public Timestamp apply(CommitResponse input) {
+ return input.getCommitTimestamp();
+ }
+ },
+ MoreExecutors.directExecutor());
+ }
+
+ @Override
+ public ApiFuture getCommitResponse() {
+ checkState(commitResponse != null, "runAsync() has not yet been called");
+ return commitResponse;
}
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolAsyncTransactionManager.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolAsyncTransactionManager.java
index e618e2b44a3..83056603f28 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolAsyncTransactionManager.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolAsyncTransactionManager.java
@@ -290,4 +290,22 @@ public TransactionState getState() {
return txnState;
}
}
+
+ public ApiFuture getCommitResponse() {
+ synchronized (lock) {
+ Preconditions.checkState(
+ txnState == TransactionState.COMMITTED,
+ "commit can only be invoked if the transaction was successfully committed");
+ }
+ return ApiFutures.transformAsync(
+ delegate,
+ new ApiAsyncFunction() {
+ @Override
+ public ApiFuture apply(AsyncTransactionManagerImpl input)
+ throws Exception {
+ return input.getCommitResponse();
+ }
+ },
+ MoreExecutors.directExecutor());
+ }
}
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManager.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManager.java
index 34e21657152..c9a56d8100a 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManager.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManager.java
@@ -87,6 +87,9 @@ public enum TransactionState {
*/
Timestamp getCommitTimestamp();
+ /** Returns the {@link CommitResponse} of this transaction. */
+ CommitResponse getCommitResponse();
+
/** Returns the state of the transaction. */
TransactionState getState();
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManagerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManagerImpl.java
index 1cef304e483..2d47fcd5c78 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManagerImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionManagerImpl.java
@@ -118,7 +118,15 @@ public Timestamp getCommitTimestamp() {
Preconditions.checkState(
txnState == TransactionState.COMMITTED,
"getCommitTimestamp can only be invoked if the transaction committed successfully");
- return txn.commitTimestamp();
+ return txn.getCommitResponse().getCommitTimestamp();
+ }
+
+ @Override
+ public CommitResponse getCommitResponse() {
+ Preconditions.checkState(
+ txnState == TransactionState.COMMITTED,
+ "getCommitResponse can only be invoked if the transaction committed successfully");
+ return txn.getCommitResponse();
}
@Override
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunner.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunner.java
index 2ad27fcd7b5..33cb57e90fe 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunner.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunner.java
@@ -74,6 +74,9 @@ interface TransactionCallable {
*/
Timestamp getCommitTimestamp();
+ /** Returns the {@link CommitResponse} of this transaction. */
+ CommitResponse getCommitResponse();
+
/**
* Allows overriding the default behaviour of blocking nested transactions.
*
diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
index a4973c29345..dbbbca068a0 100644
--- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
+++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java
@@ -31,7 +31,6 @@
import com.google.cloud.spanner.Options.TransactionOption;
import com.google.cloud.spanner.Options.UpdateOption;
import com.google.cloud.spanner.SessionImpl.SessionTransaction;
-import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
@@ -40,7 +39,6 @@
import com.google.protobuf.Empty;
import com.google.rpc.Code;
import com.google.spanner.v1.CommitRequest;
-import com.google.spanner.v1.CommitResponse;
import com.google.spanner.v1.ExecuteBatchDmlRequest;
import com.google.spanner.v1.ExecuteBatchDmlResponse;
import com.google.spanner.v1.ExecuteSqlRequest;
@@ -184,7 +182,7 @@ public void removeListener(Runnable listener) {
volatile ByteString transactionId;
- private Timestamp commitTimestamp;
+ private CommitResponse commitResponse;
private TransactionContextImpl(Builder builder) {
super(builder);
@@ -275,7 +273,7 @@ public void run() {
void commit() {
try {
- commitTimestamp = commitAsync().get();
+ commitResponse = commitAsync().get();
} catch (InterruptedException e) {
if (commitFuture != null) {
commitFuture.cancel(true);
@@ -288,10 +286,13 @@ void commit() {
volatile ApiFuture commitFuture;
- ApiFuture commitAsync() {
- final SettableApiFuture res = SettableApiFuture.create();
+ ApiFuture commitAsync() {
+ final SettableApiFuture res = SettableApiFuture.create();
final SettableApiFuture finishOps;
- CommitRequest.Builder builder = CommitRequest.newBuilder().setSession(session.getName());
+ CommitRequest.Builder builder =
+ CommitRequest.newBuilder()
+ .setSession(session.getName())
+ .setReturnCommitStats(options.withCommitStats());
synchronized (lock) {
if (transactionIdFuture == null && transactionId == null && runningAsyncOperations == 0) {
finishOps = SettableApiFuture.create();
@@ -313,12 +314,12 @@ ApiFuture commitAsync() {
}
private final class CommitRunnable implements Runnable {
- private final SettableApiFuture res;
+ private final SettableApiFuture res;
private final ApiFuture prev;
private final CommitRequest.Builder requestBuilder;
CommitRunnable(
- SettableApiFuture res,
+ SettableApiFuture res,
ApiFuture prev,
CommitRequest.Builder requestBuilder) {
this.res = res;
@@ -342,7 +343,7 @@ public void run() {
span.addAnnotation("Starting Commit");
final Span opSpan =
tracer.spanBuilderWithExplicitParent(SpannerImpl.COMMIT, span).startSpan();
- final ApiFuture commitFuture =
+ final ApiFuture commitFuture =
rpc.commitAsync(commitRequest, session.getOptions());
commitFuture.addListener(
tracer.withSpan(
@@ -351,15 +352,14 @@ public void run() {
@Override
public void run() {
try {
- CommitResponse commitResponse = commitFuture.get();
- if (!commitResponse.hasCommitTimestamp()) {
+ com.google.spanner.v1.CommitResponse proto = commitFuture.get();
+ if (!proto.hasCommitTimestamp()) {
throw newSpannerException(
ErrorCode.INTERNAL, "Missing commitTimestamp:\n" + session.getName());
}
- Timestamp ts = Timestamp.fromProto(commitResponse.getCommitTimestamp());
span.addAnnotation("Commit Done");
opSpan.end(TraceUtil.END_SPAN_OPTIONS);
- res.set(ts);
+ res.set(new CommitResponse(proto));
} catch (Throwable e) {
if (e instanceof ExecutionException) {
e =
@@ -387,9 +387,9 @@ public void run() {
}
}
- Timestamp commitTimestamp() {
- checkState(commitTimestamp != null, "run() has not yet returned normally");
- return commitTimestamp;
+ CommitResponse getCommitResponse() {
+ checkState(commitResponse != null, "run() has not yet returned normally");
+ return commitResponse;
}
boolean isAborted() {
@@ -826,11 +826,7 @@ public TransactionRunner allowNestedTransaction() {
return this;
}
- TransactionRunnerImpl(
- SessionImpl session,
- SpannerRpc rpc,
- int defaultPrefetchChunks,
- TransactionOption... options) {
+ TransactionRunnerImpl(SessionImpl session, TransactionOption... options) {
this.session = session;
this.options = Options.fromTransactionOptions(options);
this.txn = session.newTransaction(this.options);
@@ -955,7 +951,12 @@ public T call() {
@Override
public Timestamp getCommitTimestamp() {
checkState(txn != null, "run() has not yet returned normally");
- return txn.commitTimestamp();
+ return txn.getCommitResponse().getCommitTimestamp();
+ }
+
+ public CommitResponse getCommitResponse() {
+ checkState(txn != null, "run() has not yet returned normally");
+ return txn.getCommitResponse();
}
@Override
diff --git a/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncRunnerImplTest.java b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncRunnerImplTest.java
new file mode 100644
index 00000000000..fab29d29005
--- /dev/null
+++ b/google-cloud-spanner/src/test/java/com/google/cloud/spanner/AsyncRunnerImplTest.java
@@ -0,0 +1,156 @@
+/*
+ * 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.spanner;
+
+import static com.google.cloud.spanner.SpannerApiFutures.get;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import com.google.api.core.ApiFuture;
+import com.google.api.core.ApiFutures;
+import com.google.cloud.spanner.AsyncRunner.AsyncWork;
+import com.google.cloud.spanner.TransactionRunner.TransactionCallable;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.junit.AfterClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class AsyncRunnerImplTest {
+ private static final ExecutorService executor = Executors.newSingleThreadExecutor();
+
+ @AfterClass
+ public static void teardown() {
+ executor.shutdown();
+ }
+
+ @SuppressWarnings("unchecked")
+ @Test
+ public void testAsyncRunReturnsResultAndCommitResponse() {
+ final Object expectedResult = new Object();
+ final CommitResponse expectedCommitResponse = mock(CommitResponse.class);
+
+ TransactionRunnerImpl delegate = mock(TransactionRunnerImpl.class);
+ when(delegate.run(any(TransactionCallable.class))).thenReturn(expectedResult);
+ when(delegate.getCommitResponse()).thenReturn(expectedCommitResponse);
+
+ AsyncRunnerImpl runner = new AsyncRunnerImpl(delegate);
+ ApiFuture