|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.spanner.v1.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * When a read-write transaction is executed on a multiplexed session, this precommit token is sent |
| 21 | + * back to the client as a part of the [Transaction] message in the BeginTransaction response and |
| 22 | + * also as a part of the [ResultSet] and [PartialResultSet] responses. |
| 23 | + * |
| 24 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 25 | + * transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: |
| 26 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 27 | + * </p> |
| 28 | + * |
| 29 | + * @author Google, Inc. |
| 30 | + */ |
| 31 | +@SuppressWarnings("javadoc") |
| 32 | +public final class MultiplexedSessionPrecommitToken extends com.google.api.client.json.GenericJson { |
| 33 | + |
| 34 | + /** |
| 35 | + * Opaque precommit token. |
| 36 | + * The value may be {@code null}. |
| 37 | + */ |
| 38 | + @com.google.api.client.util.Key |
| 39 | + private java.lang.String precommitToken; |
| 40 | + |
| 41 | + /** |
| 42 | + * An incrementing seq number is generated on every precommit token that is returned. Clients |
| 43 | + * should remember the precommit token with the highest sequence number from the current |
| 44 | + * transaction attempt. |
| 45 | + * The value may be {@code null}. |
| 46 | + */ |
| 47 | + @com.google.api.client.util.Key |
| 48 | + private java.lang.Integer seqNum; |
| 49 | + |
| 50 | + /** |
| 51 | + * Opaque precommit token. |
| 52 | + * @see #decodePrecommitToken() |
| 53 | + * @return value or {@code null} for none |
| 54 | + */ |
| 55 | + public java.lang.String getPrecommitToken() { |
| 56 | + return precommitToken; |
| 57 | + } |
| 58 | + |
| 59 | + /** |
| 60 | + * Opaque precommit token. |
| 61 | + * @see #getPrecommitToken() |
| 62 | + * @return Base64 decoded value or {@code null} for none |
| 63 | + * |
| 64 | + * @since 1.14 |
| 65 | + */ |
| 66 | + public byte[] decodePrecommitToken() { |
| 67 | + return com.google.api.client.util.Base64.decodeBase64(precommitToken); |
| 68 | + } |
| 69 | + |
| 70 | + /** |
| 71 | + * Opaque precommit token. |
| 72 | + * @see #encodePrecommitToken() |
| 73 | + * @param precommitToken precommitToken or {@code null} for none |
| 74 | + */ |
| 75 | + public MultiplexedSessionPrecommitToken setPrecommitToken(java.lang.String precommitToken) { |
| 76 | + this.precommitToken = precommitToken; |
| 77 | + return this; |
| 78 | + } |
| 79 | + |
| 80 | + /** |
| 81 | + * Opaque precommit token. |
| 82 | + * @see #setPrecommitToken() |
| 83 | + * |
| 84 | + * <p> |
| 85 | + * The value is encoded Base64 or {@code null} for none. |
| 86 | + * </p> |
| 87 | + * |
| 88 | + * @since 1.14 |
| 89 | + */ |
| 90 | + public MultiplexedSessionPrecommitToken encodePrecommitToken(byte[] precommitToken) { |
| 91 | + this.precommitToken = com.google.api.client.util.Base64.encodeBase64URLSafeString(precommitToken); |
| 92 | + return this; |
| 93 | + } |
| 94 | + |
| 95 | + /** |
| 96 | + * An incrementing seq number is generated on every precommit token that is returned. Clients |
| 97 | + * should remember the precommit token with the highest sequence number from the current |
| 98 | + * transaction attempt. |
| 99 | + * @return value or {@code null} for none |
| 100 | + */ |
| 101 | + public java.lang.Integer getSeqNum() { |
| 102 | + return seqNum; |
| 103 | + } |
| 104 | + |
| 105 | + /** |
| 106 | + * An incrementing seq number is generated on every precommit token that is returned. Clients |
| 107 | + * should remember the precommit token with the highest sequence number from the current |
| 108 | + * transaction attempt. |
| 109 | + * @param seqNum seqNum or {@code null} for none |
| 110 | + */ |
| 111 | + public MultiplexedSessionPrecommitToken setSeqNum(java.lang.Integer seqNum) { |
| 112 | + this.seqNum = seqNum; |
| 113 | + return this; |
| 114 | + } |
| 115 | + |
| 116 | + @Override |
| 117 | + public MultiplexedSessionPrecommitToken set(String fieldName, Object value) { |
| 118 | + return (MultiplexedSessionPrecommitToken) super.set(fieldName, value); |
| 119 | + } |
| 120 | + |
| 121 | + @Override |
| 122 | + public MultiplexedSessionPrecommitToken clone() { |
| 123 | + return (MultiplexedSessionPrecommitToken) super.clone(); |
| 124 | + } |
| 125 | + |
| 126 | +} |
0 commit comments