Class DatabaseName (4.0.0)

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

Resource name for the Database resource.

Inheritance

Object > DatabaseName

Namespace

Google.Cloud.Spanner.Common.V1

Assembly

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
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.

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; }
Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public DatabaseName.ResourceNameType Type { get; }

The DatabaseName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DatabaseName.ResourceNameType

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)

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
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.

Returns
TypeDescription
String

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

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
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.

Returns
TypeDescription
String

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

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
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.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DatabaseName

A new instance of DatabaseName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DatabaseName Parse(string databaseName)

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

Parameter
NameDescription
databaseNameString

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

Returns
TypeDescription
DatabaseName

The parsed DatabaseName if successful.

Remarks

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
NameDescription
databaseNameString

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

allowUnparsedBoolean

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
DatabaseName

The parsed DatabaseName if successful.

Remarks

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

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

ToString()

public override string ToString()
Returns
TypeDescription
String
Overrides

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
NameDescription
databaseNameString

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

resultDatabaseName

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

Returns
TypeDescription
Boolean

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}

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
NameDescription
databaseNameString

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

allowUnparsedBoolean

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.

resultDatabaseName

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

Returns
TypeDescription
Boolean

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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(DatabaseName, DatabaseName)

public static bool operator ==(DatabaseName a, DatabaseName b)
Parameters
NameDescription
aDatabaseName
bDatabaseName
Returns
TypeDescription
Boolean

Inequality(DatabaseName, DatabaseName)

public static bool operator !=(DatabaseName a, DatabaseName b)
Parameters
NameDescription
aDatabaseName
bDatabaseName
Returns
TypeDescription
Boolean