com.google.api.services.spanner.v1.model.Session Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-spanner Show documentation
There is a newer version: v1-rev20241020-2.0.0
Show newest version
/*
 * 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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.spanner.v1.model;

/**
 * A session in the Cloud Spanner API.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class Session extends com.google.api.client.json.GenericJson {

  /**
   * Output only. The approximate timestamp when the session is last used. It is typically earlier
   * than the actual last use time.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String approximateLastUseTime;

  /**
   * Output only. The timestamp when the session is created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String createTime;

  /**
   * The database role which created this session.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String creatorRole;

  /**
   * The labels for the session. * Label keys must be between 1 and 63 characters long and must
   * conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must
   * be between 0 and 63 characters long and must conform to the regular expression
   * `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given
   * session. See https://goo.gl/xmQnxf for more information on and examples of labels.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map labels;

  /**
   * Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple,
   * concurrent read-only operations. Don't use them for read-write transactions, partitioned reads,
   * or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use
   * BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed
   * sessions.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean multiplexed;

  /**
   * Output only. The name of the session. This is always system-assigned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. The approximate timestamp when the session is last used. It is typically earlier
   * than the actual last use time.
   * @return value or {@code null} for none
   */
  public String getApproximateLastUseTime() {
    return approximateLastUseTime;
  }

  /**
   * Output only. The approximate timestamp when the session is last used. It is typically earlier
   * than the actual last use time.
   * @param approximateLastUseTime approximateLastUseTime or {@code null} for none
   */
  public Session setApproximateLastUseTime(String approximateLastUseTime) {
    this.approximateLastUseTime = approximateLastUseTime;
    return this;
  }

  /**
   * Output only. The timestamp when the session is created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * Output only. The timestamp when the session is created.
   * @param createTime createTime or {@code null} for none
   */
  public Session setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * The database role which created this session.
   * @return value or {@code null} for none
   */
  public java.lang.String getCreatorRole() {
    return creatorRole;
  }

  /**
   * The database role which created this session.
   * @param creatorRole creatorRole or {@code null} for none
   */
  public Session setCreatorRole(java.lang.String creatorRole) {
    this.creatorRole = creatorRole;
    return this;
  }

  /**
   * The labels for the session. * Label keys must be between 1 and 63 characters long and must
   * conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must
   * be between 0 and 63 characters long and must conform to the regular expression
   * `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given
   * session. See https://goo.gl/xmQnxf for more information on and examples of labels.
   * @return value or {@code null} for none
   */
  public java.util.Map getLabels() {
    return labels;
  }

  /**
   * The labels for the session. * Label keys must be between 1 and 63 characters long and must
   * conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must
   * be between 0 and 63 characters long and must conform to the regular expression
   * `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given
   * session. See https://goo.gl/xmQnxf for more information on and examples of labels.
   * @param labels labels or {@code null} for none
   */
  public Session setLabels(java.util.Map labels) {
    this.labels = labels;
    return this;
  }

  /**
   * Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple,
   * concurrent read-only operations. Don't use them for read-write transactions, partitioned reads,
   * or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use
   * BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed
   * sessions.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getMultiplexed() {
    return multiplexed;
  }

  /**
   * Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple,
   * concurrent read-only operations. Don't use them for read-write transactions, partitioned reads,
   * or partitioned queries. Use CreateSession to create multiplexed sessions. Don't use
   * BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed
   * sessions.
   * @param multiplexed multiplexed or {@code null} for none
   */
  public Session setMultiplexed(java.lang.Boolean multiplexed) {
    this.multiplexed = multiplexed;
    return this;
  }

  /**
   * Output only. The name of the session. This is always system-assigned.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. The name of the session. This is always system-assigned.
   * @param name name or {@code null} for none
   */
  public Session setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  @Override
  public Session set(String fieldName, Object value) {
    return (Session) super.set(fieldName, value);
  }

  @Override
  public Session clone() {
    return (Session) super.clone();
  }

}