public sealed class DatabaseName : IResourceName, IEquatable<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 |
Boolean |
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 |
DatabaseName.ResourceNameType |
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 |
Int32 |
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, Boolean)
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 | Boolean 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 |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/instances/{instance}/databases/{database}
TryParse(String, Boolean, 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 | Boolean If |
result | DatabaseName When this method returns, the parsed DatabaseName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/instances/{instance}/databases/{database}
allowUnparsed
is true
.
Operators
Equality(DatabaseName, DatabaseName)
public static bool operator ==(DatabaseName a, DatabaseName b)
Parameters | |
---|---|
Name | Description |
a | DatabaseName |
b | DatabaseName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(DatabaseName, DatabaseName)
public static bool operator !=(DatabaseName a, DatabaseName b)
Parameters | |
---|---|
Name | Description |
a | DatabaseName |
b | DatabaseName |
Returns | |
---|---|
Type | Description |
Boolean |