Google Cloud Spanner v1 API - Class SessionName (4.3.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class SessionName : IResourceName, IEquatable<SessionName>

Reference documentation and code samples for the Google Cloud Spanner v1 API class SessionName.

Resource name for the Session resource.

Inheritance

object > SessionName

Namespace

GoogleGoogle.CloudGoogle.Cloud.SpannerV1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

SessionName(string, string, string, string)

public SessionName(string projectId, string instanceId, string databaseId, string sessionId)

Constructs a new instance of a SessionName class from the component parts of pattern projects/{project}/instances/{instance}/databases/{database}/sessions/{session}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

databaseIdstring

The Database ID. Must not be null or empty.

sessionIdstring

The Session ID. Must not be null or empty.

Properties

DatabaseId

public string DatabaseId { get; }

The Database ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

InstanceId

public string InstanceId { get; }

The Instance ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

SessionId

public string SessionId { get; }

The Session ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public SessionName.ResourceNameType Type { get; }

The SessionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SessionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string instanceId, string databaseId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

databaseIdstring

The Database ID. Must not be null or empty.

sessionIdstring

The Session ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SessionName with pattern projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.

FormatProjectInstanceDatabaseSession(string, string, string, string)

public static string FormatProjectInstanceDatabaseSession(string projectId, string instanceId, string databaseId, string sessionId)

Formats the IDs into the string representation of this SessionName with pattern projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

databaseIdstring

The Database ID. Must not be null or empty.

sessionIdstring

The Session ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SessionName with pattern projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.

FromProjectInstanceDatabaseSession(string, string, string, string)

public static SessionName FromProjectInstanceDatabaseSession(string projectId, string instanceId, string databaseId, string sessionId)

Creates a SessionName with the pattern projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

instanceIdstring

The Instance ID. Must not be null or empty.

databaseIdstring

The Database ID. Must not be null or empty.

sessionIdstring

The Session ID. Must not be null or empty.

Returns
TypeDescription
SessionName

A new instance of SessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SessionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SessionName

A new instance of SessionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static SessionName Parse(string sessionName)

Parses the given resource name string into a new SessionName instance.

Parameter
NameDescription
sessionNamestring

The resource name in string form. Must not be null.

Returns
TypeDescription
SessionName

The parsed SessionName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/instances/{instance}/databases/{database}/sessions/{session}

Parse(string, bool)

public static SessionName Parse(string sessionName, bool allowUnparsed)

Parses the given resource name string into a new SessionName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
sessionNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
TypeDescription
SessionName

The parsed SessionName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/instances/{instance}/databases/{database}/sessions/{session}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out SessionName)

public static bool TryParse(string sessionName, out SessionName result)

Tries to parse the given resource name string into a new SessionName instance.

Parameters
NameDescription
sessionNamestring

The resource name in string form. Must not be null.

resultSessionName

When this method returns, the parsed SessionName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/instances/{instance}/databases/{database}/sessions/{session}

TryParse(string, bool, out SessionName)

public static bool TryParse(string sessionName, bool allowUnparsed, out SessionName result)

Tries to parse the given resource name string into a new SessionName instance; optionally allowing an unparseable resource name.

Parameters
NameDescription
sessionNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

resultSessionName

When this method returns, the parsed SessionName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/instances/{instance}/databases/{database}/sessions/{session}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SessionName, SessionName)

public static bool operator ==(SessionName a, SessionName b)
Parameters
NameDescription
aSessionName
bSessionName
Returns
TypeDescription
bool

operator !=(SessionName, SessionName)

public static bool operator !=(SessionName a, SessionName b)
Parameters
NameDescription
aSessionName
bSessionName
Returns
TypeDescription
bool