Interface SessionOrBuilder (6.82.0)

Version 6.82.0

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public interface SessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

• 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getApproximateLastUseTime()

public abstract 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];

Returns
Type	Description
Timestamp	The approximateLastUseTime.

getApproximateLastUseTimeOrBuilder()

public abstract 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];

Returns
Type	Description
TimestampOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp when the session is created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the session is created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCreatorRole()

public abstract String getCreatorRole()

The database role which created this session.

string creator_role = 5;

Returns
Type	Description
String	The creatorRole.

getCreatorRoleBytes()

public abstract ByteString getCreatorRoleBytes()

The database role which created this session.

string creator_role = 5;

Returns
Type	Description
ByteString	The bytes for creatorRole.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

• 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;

Returns
Type	Description
int

getLabelsMap()

public abstract 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?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

• 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;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

• 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract 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?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

• 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMultiplexed()

public abstract 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 but not via BatchCreateSessions. Multiplexed sessions may not be deleted nor listed.

bool multiplexed = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The multiplexed.

getName()

public abstract String getName()

Output only. The name of the session. This is always system-assigned.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The name of the session. This is always system-assigned.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

hasApproximateLastUseTime()

public abstract 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];

Returns
Type	Description
boolean	Whether the approximateLastUseTime field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp when the session is created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.