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.
Namespace
GoogleGoogle.CloudGoogle.Cloud.SpannerV1Assembly
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 | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
sessionId | string The |
Properties
DatabaseId
public string DatabaseId { get; }
The Database
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
InstanceId
public string InstanceId { get; }
The Instance
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
bool |
ProjectId
public string ProjectId { get; }
The Project
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
SessionId
public string SessionId { get; }
The Session
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public SessionName.ResourceNameType Type { get; }
The SessionName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
SessionNameResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
sessionId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this SessionName with pattern
|
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 | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
sessionId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this SessionName with pattern
|
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 | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
sessionId | string The |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
SessionName | A new instance of SessionName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static SessionName Parse(string sessionName)
Parses the given resource name string into a new SessionName instance.
Parameter | |
---|---|
Name | Description |
sessionName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
SessionName | The parsed SessionName if successful. |
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 | |
---|---|
Name | Description |
sessionName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
SessionName | The parsed SessionName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/instances/{instance}/databases/{database}/sessions/{session}
allowUnparsed
is true
.
ToString()
public override string ToString()
The string representation of the resource name.
Returns | |
---|---|
Type | Description |
string | The string representation of the resource name. |
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 | |
---|---|
Name | Description |
sessionName | string The resource name in string form. Must not be |
result | SessionName When this method returns, the parsed SessionName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 | |
---|---|
Name | Description |
sessionName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | SessionName When this method returns, the parsed SessionName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/instances/{instance}/databases/{database}/sessions/{session}
allowUnparsed
is true
.
Operators
operator ==(SessionName, SessionName)
public static bool operator ==(SessionName a, SessionName b)
Parameters | |
---|---|
Name | Description |
a | SessionName |
b | SessionName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(SessionName, SessionName)
public static bool operator !=(SessionName a, SessionName b)
Parameters | |
---|---|
Name | Description |
a | SessionName |
b | SessionName |
Returns | |
---|---|
Type | Description |
bool |