Package com.google.spanner.v1

Class Session

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.Session
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SessionOrBuilder, Serializable
public final class Session extends com.google.protobuf.GeneratedMessageV3 implements SessionOrBuilder
 A session in the Cloud Spanner API.
Protobuf type google.spanner.v1.Session
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Session.Builder
    A session in the Cloud Spanner API.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    APPROXIMATE_LAST_USE_TIME_FIELD_NUMBER
     
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    CREATOR_ROLE_FIELD_NUMBER
     
    static final int
    LABELS_FIELD_NUMBER
     
    static final int
    MULTIPLEXED_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLabels(String key)
    The labels for the session
    boolean
    equals(Object obj)
     
    com.google.protobuf.Timestamp
    getApproximateLastUseTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getApproximateLastUseTimeOrBuilder()
    Output only.
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    String
    getCreatorRole()
    The database role which created this session.
    com.google.protobuf.ByteString
    getCreatorRoleBytes()
    The database role which created this session.
    static Session
    getDefaultInstance()
     
    Session
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    The labels for the session
    Map<String,String>
    getLabelsMap()
    The labels for the session
    String
    getLabelsOrDefault(String key, String defaultValue)
    The labels for the session
    String
    getLabelsOrThrow(String key)
    The labels for the session
    boolean
    getMultiplexed()
    Optional.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<Session>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasApproximateLastUseTime()
    Output only.
    boolean
    hasCreateTime()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Session.Builder
    newBuilder()
     
    static Session.Builder
    newBuilder(Session prototype)
     
    Session.Builder
    newBuilderForType()
     
    protected Session.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Session
    parseDelimitedFrom(InputStream input)
     
    static Session
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Session
    parseFrom(byte[] data)
     
    static Session
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Session
    parseFrom(com.google.protobuf.ByteString data)
     
    static Session
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Session
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Session
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Session
    parseFrom(InputStream input)
     
    static Session
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Session
    parseFrom(ByteBuffer data)
     
    static Session
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Session>
    parser()
     
    Session.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • APPROXIMATE_LAST_USE_TIME_FIELD_NUMBER

      public static final int APPROXIMATE_LAST_USE_TIME_FIELD_NUMBER
      See Also:

    • CREATOR_ROLE_FIELD_NUMBER

      public static final int CREATOR_ROLE_FIELD_NUMBER
      See Also:

    • MULTIPLEXED_FIELD_NUMBER

      public static final int MULTIPLEXED_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public String getName()
       Output only. The name of the session. This is always system-assigned.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface SessionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The name of the session. This is always system-assigned.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface SessionOrBuilder
      Returns:
      The bytes for name.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: SessionOrBuilder
       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.
      map<string, string> labels = 2;
      Specified by:
      getLabelsCount in interface SessionOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       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.
      map<string, string> labels = 2;
      Specified by:
      containsLabels in interface SessionOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface SessionOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       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.
      map<string, string> labels = 2;
      Specified by:
      getLabelsMap in interface SessionOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       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.
      map<string, string> labels = 2;
      Specified by:
      getLabelsOrDefault in interface SessionOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       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.
      map<string, string> labels = 2;
      Specified by:
      getLabelsOrThrow in interface SessionOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp when the session is created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface SessionOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp when the session is created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface SessionOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when the session is created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface SessionOrBuilder

    • hasApproximateLastUseTime

      public boolean hasApproximateLastUseTime()
       Output only. The approximate timestamp when the session is last used. It is
 typically earlier than the actual last use time.
      .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasApproximateLastUseTime in interface SessionOrBuilder
      Returns:
      Whether the approximateLastUseTime field is set.

    • getApproximateLastUseTime

      public com.google.protobuf.Timestamp getApproximateLastUseTime()
       Output only. The approximate timestamp when the session is last used. It is
 typically earlier than the actual last use time.
      .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getApproximateLastUseTime in interface SessionOrBuilder
      Returns:
      The approximateLastUseTime.

    • getApproximateLastUseTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getApproximateLastUseTimeOrBuilder()
       Output only. The approximate timestamp when the session is last used. It is
 typically earlier than the actual last use time.
      .google.protobuf.Timestamp approximate_last_use_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getApproximateLastUseTimeOrBuilder in interface SessionOrBuilder

    • getCreatorRole

      public String getCreatorRole()
       The database role which created this session.
      string creator_role = 5;
      Specified by:
      getCreatorRole in interface SessionOrBuilder
      Returns:
      The creatorRole.

    • getCreatorRoleBytes

      public com.google.protobuf.ByteString getCreatorRoleBytes()
       The database role which created this session.
      string creator_role = 5;
      Specified by:
      getCreatorRoleBytes in interface SessionOrBuilder
      Returns:
      The bytes for creatorRole.

    • getMultiplexed

      public boolean getMultiplexed()
       Optional. If true, specifies a multiplexed session. A multiplexed session
 may be used for multiple, concurrent read-only operations but can not be
 used for read-write transactions, partitioned reads, or partitioned
 queries. Multiplexed sessions can be created via
 [CreateSession][google.spanner.v1.Spanner.CreateSession] but not via
 [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions].
 Multiplexed sessions may not be deleted nor listed.
      bool multiplexed = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMultiplexed in interface SessionOrBuilder
      Returns:
      The multiplexed.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Session parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Session parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Session parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Session parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Session parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Session parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Session parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Session parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Session parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Session parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Session parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Session parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Session.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Session.Builder newBuilder()

    • newBuilder

      public static Session.Builder newBuilder(Session prototype)

    • toBuilder

      public Session.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Session.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Session getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Session> parser()

    • getParserForType

      public com.google.protobuf.Parser<Session> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Session getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder