public sealed class DatabaseName : IResourceName, IEquatable<DatabaseName>
Reference documentation and code samples for the Google.Cloud.Spanner.Common.V1 class DatabaseName.
Resource name for the Database
resource.
Namespace
Google.Cloud.Spanner.Common.V1Assembly
Google.Cloud.Spanner.Common.V1.dll
Constructors
DatabaseName(string, string, string)
public DatabaseName(string projectId, string instanceId, string databaseId)
Constructs a new instance of a DatabaseName class from the component parts of pattern
projects/{project}/instances/{instance}/databases/{database}
Parameters | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | 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; }
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 |
Type
public DatabaseName.ResourceNameType Type { get; }
The DatabaseName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
DatabaseNameResourceNameType |
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)
public static string Format(string projectId, string instanceId, string databaseId)
Formats the IDs into the string representation of this DatabaseName with pattern
projects/{project}/instances/{instance}/databases/{database}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this DatabaseName with pattern
|
FormatProjectInstanceDatabase(string, string, string)
public static string FormatProjectInstanceDatabase(string projectId, string instanceId, string databaseId)
Formats the IDs into the string representation of this DatabaseName with pattern
projects/{project}/instances/{instance}/databases/{database}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this DatabaseName with pattern
|
FromProjectInstanceDatabase(string, string, string)
public static DatabaseName FromProjectInstanceDatabase(string projectId, string instanceId, string databaseId)
Creates a DatabaseName with the pattern
projects/{project}/instances/{instance}/databases/{database}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
instanceId | string The |
databaseId | string The |
Returns | |
---|---|
Type | Description |
DatabaseName | A new instance of DatabaseName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static DatabaseName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a DatabaseName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
DatabaseName | A new instance of DatabaseName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static DatabaseName Parse(string databaseName)
Parses the given resource name string into a new DatabaseName instance.
Parameter | |
---|---|
Name | Description |
databaseName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
DatabaseName | The parsed DatabaseName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/instances/{instance}/databases/{database}
Parse(string, bool)
public static DatabaseName Parse(string databaseName, bool allowUnparsed)
Parses the given resource name string into a new DatabaseName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
databaseName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
DatabaseName | The parsed DatabaseName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/instances/{instance}/databases/{database}
allowUnparsed
is true
.
ToString()
public override string ToString()
Returns | |
---|---|
Type | Description |
string |
TryParse(string, out DatabaseName)
public static bool TryParse(string databaseName, out DatabaseName result)
Tries to parse the given resource name string into a new DatabaseName instance.
Parameters | |
---|---|
Name | Description |
databaseName | string The resource name in string form. Must not be |
result | DatabaseName When this method returns, the parsed DatabaseName, 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}
TryParse(string, bool, out DatabaseName)
public static bool TryParse(string databaseName, bool allowUnparsed, out DatabaseName result)
Tries to parse the given resource name string into a new DatabaseName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
databaseName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | DatabaseName When this method returns, the parsed DatabaseName, 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}
allowUnparsed
is true
.
Operators
operator ==(DatabaseName, DatabaseName)
public static bool operator ==(DatabaseName a, DatabaseName b)
Parameters | |
---|---|
Name | Description |
a | DatabaseName |
b | DatabaseName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(DatabaseName, DatabaseName)
public static bool operator !=(DatabaseName a, DatabaseName b)
Parameters | |
---|---|
Name | Description |
a | DatabaseName |
b | DatabaseName |
Returns | |
---|---|
Type | Description |
bool |