Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::Session (v1.0.0)

Version 1.0.0

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.2
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.4

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::Session.

A session in the Cloud Spanner API.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#approximate_last_use_time

def approximate_last_use_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The timestamp when the session is created.

#creator_role

def creator_role() -> ::String

Returns

• (::String) — The database role which created this session.

#creator_role=

def creator_role=(value) -> ::String

Parameter

• value (::String) — The database role which created this session.

Returns

• (::String) — The database role which created this session.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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.

#multiplexed

def multiplexed() -> ::Boolean

Returns

• (::Boolean) — 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 but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.

#multiplexed=

def multiplexed=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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 but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.

Returns

• (::Boolean) — 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 but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.

#name

def name() -> ::String

Returns

• (::String) — Output only. The name of the session. This is always system-assigned.